org.eml.MMAX2.api
Interface AnnotationSchemeAPI

All Known Implementing Classes:
MMAX2AnnotationScheme

public interface AnnotationSchemeAPI

This interface defines public methods for accessing MMAX2AnnotationScheme objects.


Method Summary
 MMAX2Attribute getAttributeByID(java.lang.String attributeID)
          (API) Returns the MMAX2Attribute object with ID attributeID, as defined in annotation scheme file.
 MMAX2Attribute[] getAttributesByName(java.lang.String attributeNameRegExp)
          (API) Returns an array of all MMAX2Attribute objects of whose name matches the RegExp attributeNameRegExp.
 MMAX2Attribute[] getAttributesByNameAndType(java.lang.String attributeNameRegExp, int attributeType)
          (API) Returns an array of all MMAX2Attribute objects of type attributeType whose name matches the RegExp attributeNameRegExp.
 MMAX2Attribute[] getAttributesByNameAndType(java.lang.String attributeNameRegExp, int attributeType1, int attributeType2)
          (API) Returns an array of all MMAX2Attribute objects of type attributeType1 or attributeType2 whose name matches the RegExp attributeNameRegExp.
 MMAX2Attribute[] getAttributesByType(int attributeType)
          (API) Returns an array of all MMAX2Attribute objects of type attributeType.
 MMAX2Attribute[] getAttributesByType(int attributeType1, int attributeType2)
          (API) Returns an array of all MMAX2Attribute objects of either type attributeType1 or attributeType2.
 MMAX2Attribute getUniqueAttributeByName(java.lang.String attributeNameRegExp)
          (API) Returns the MMAX2Attribute object whose name matches the RegExp attributeNameRegExp.
 MMAX2Attribute getUniqueAttributeByNameAndType(java.lang.String attributeNameRegExp, int attributeType)
          (API) Returns the MMAX2Attribute object of type attributeType whose name matches the RegExp attributeNameRegExp.
 MMAX2Attribute getUniqueAttributeByNameAndType(java.lang.String attributeNameRegExp, int attributeType1, int attributeType2)
          (API) Returns a MMAX2Attribute object of type attributeType1 or attributeType2 whose name matches the RegExp attributeNameRegExp.
 MMAX2Attribute getUniqueAttributeByType(int attributeType)
          (API) Returns the MMAX2Attribute object of type attributeType.
 MMAX2Attribute getUniqueAttributeByType(int attributeType1, int attributeType2)
          (API) Returns the MMAX2Attribute object of either type attributeType1 or attributeType2.
 

Method Detail

getAttributesByType

MMAX2Attribute[] getAttributesByType(int attributeType)
(API) Returns an array of all MMAX2Attribute objects of type attributeType.

Parameters:
attributeType - The type of the MMAX2Attribute objects to return, as specified in the annotation scheme file, one of the values defined in AttributeAPI.
Returns:
An array of MMAX2Attribute objects of type attributeType, or empty array.

getUniqueAttributeByType

MMAX2Attribute getUniqueAttributeByType(int attributeType)
(API) Returns the MMAX2Attribute object of type attributeType.

Parameters:
attributeType - The type of the MMAX2Attribute object to return, as specified in the annotation scheme file, one of the values defined in AttributeAPI.
Returns:
A MMAX2Attribute objects of type attributeType, or null.

getAttributesByType

MMAX2Attribute[] getAttributesByType(int attributeType1,
                                     int attributeType2)
(API) Returns an array of all MMAX2Attribute objects of either type attributeType1 or attributeType2.

Parameters:
attributeType1 - The type of the MMAX2Attribute objects to return, as specified in the annotation scheme file, one of the values defined in AttributeAPI.
attributeType2 - The type of the MMAX2Attribute objects to return, as specified in the annotation scheme file, one of the values defined in AttributeAPI.
Returns:
An array of MMAX2Attribute objects of type attributeType1 and attributeType2, or empty array.

getUniqueAttributeByType

MMAX2Attribute getUniqueAttributeByType(int attributeType1,
                                        int attributeType2)
(API) Returns the MMAX2Attribute object of either type attributeType1 or attributeType2.

Parameters:
attributeType1 - The type of the MMAX2Attribute object to return, as specified in the annotation scheme file, one of the values defined in AttributeAPI.
attributeType2 - The type of the MMAX2Attribute object to return, as specified in the annotation scheme file, one of the values defined in AttributeAPI.
Returns:
A MMAX2Attribute object of type attributeType1 or attributeType2, or empty array.

getAttributesByName

MMAX2Attribute[] getAttributesByName(java.lang.String attributeNameRegExp)
(API) Returns an array of all MMAX2Attribute objects of whose name matches the RegExp attributeNameRegExp.

Parameters:
attributeNameRegExp - A regular expression to match the name(s) of the MMAX2Attribute object(s) to return, as specified in the annotation scheme file.
Returns:
An array of MMAX2Attribute objects whose names match the RegExp attributeName, or empty array.

getUniqueAttributeByName

MMAX2Attribute getUniqueAttributeByName(java.lang.String attributeNameRegExp)
(API) Returns the MMAX2Attribute object whose name matches the RegExp attributeNameRegExp.

Parameters:
attributeNameRegExp - A regular expression to match the name(s) of the MMAX2Attribute object(s) to return, as specified in the annotation scheme file.
Returns:
An array of MMAX2Attribute objects whose names match the RegExp attributeName, or empty array.

getAttributesByNameAndType

MMAX2Attribute[] getAttributesByNameAndType(java.lang.String attributeNameRegExp,
                                            int attributeType)
(API) Returns an array of all MMAX2Attribute objects of type attributeType whose name matches the RegExp attributeNameRegExp.

Parameters:
attributeNameRegExp - A regular expression to match the name(s) of the MMAX2Attribute object(s) to return, as specified in the annotation scheme file.
attributeType - The type of the MMAX2Attribute objects to return, as specified in the annotation scheme file, one of the values defined in AttributeAPI.
Returns:
An array of MMAX2Attribute objects of type attributeType whose name match attributeNameRegExp, or empty array.

getUniqueAttributeByNameAndType

MMAX2Attribute getUniqueAttributeByNameAndType(java.lang.String attributeNameRegExp,
                                               int attributeType)
(API) Returns the MMAX2Attribute object of type attributeType whose name matches the RegExp attributeNameRegExp.

Parameters:
attributeNameRegExp - A regular expression to match the name of the MMAX2Attribute object to return, as specified in the annotation scheme file.
attributeType - The type of the MMAX2Attribute object to return, as specified in the annotation scheme file, one of the values defined in AttributeAPI.
Returns:
A MMAX2Attribute object of type attributeType whose name match attributeNameRegExp, or empty array.

getAttributesByNameAndType

MMAX2Attribute[] getAttributesByNameAndType(java.lang.String attributeNameRegExp,
                                            int attributeType1,
                                            int attributeType2)
(API) Returns an array of all MMAX2Attribute objects of type attributeType1 or attributeType2 whose name matches the RegExp attributeNameRegExp.

Parameters:
attributeNameRegExp - A regular expression to match the name(s) of the MMAX2Attribute object(s) to return, as specified in the annotation scheme file.
attributeType1 - The type of the MMAX2Attribute objects to return, as specified in the annotation scheme file, one of the values defined in AttributeAPI.
attributeType2 - The type of the MMAX2Attribute objects to return, as specified in the annotation scheme file, one of the values defined in AttributeAPI.
Returns:
An array of MMAX2Attribute objects of type attributeType1 or attributeType2 whose name match attributeNameRegExp, or empty array.

getUniqueAttributeByNameAndType

MMAX2Attribute getUniqueAttributeByNameAndType(java.lang.String attributeNameRegExp,
                                               int attributeType1,
                                               int attributeType2)
(API) Returns a MMAX2Attribute object of type attributeType1 or attributeType2 whose name matches the RegExp attributeNameRegExp.

Parameters:
attributeNameRegExp - A regular expression to match the name of the MMAX2Attribute object to return, as specified in the annotation scheme file.
attributeType1 - The type of the MMAX2Attribute object to return, as specified in the annotation scheme file, one of the values defined in AttributeAPI.
attributeType2 - The type of the MMAX2Attribute object to return, as specified in the annotation scheme file, one of the values defined in AttributeAPI.
Returns:
A MMAX2Attribute objects of type attributeType1 or attributeType2 whose name match attributeNameRegExp, or empty array.

getAttributeByID

MMAX2Attribute getAttributeByID(java.lang.String attributeID)
(API) Returns the MMAX2Attribute object with ID attributeID, as defined in annotation scheme file.

Parameters:
attributeID - The ID of the MMAX2Attribute object to return.
Returns:
The MMAX2Attribute object with ID attributeID, or null.