TypeDefinitionExtendibleEnumeration (MAJ API)

Overview

Package

Class

Tree

Deprecated

Index

Media Authoring
with Java API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

tv.amwa.maj.meta
Class TypeDefinitionExtendibleEnumeration

java.lang.Object
  tv.amwa.maj.meta.MetaDefinition
      tv.amwa.maj.meta.TypeDefinition
          tv.amwa.maj.meta.TypeDefinitionExtendibleEnumeration

All Implemented Interfaces:: Serializable, DefinitionType, MetaDefinition, TypeDefinition, TypeDefinitionExtendibleEnumeration, XMLSerializable, MAJCommon

@AAFClass(uuid1=218169601, uuid2=544, uuid3=0, uuid4={6,14,43,52,2,6,1,1}, definedName="TypeDefinitionExtendibleEnumeration", description="The TypeDefinitionExtendibleEnumeration class defines a property type that can have one of an extendible set of AUID values.") public final class TypeDefinitionExtendibleEnumeration
extends TypeDefinition
implements TypeDefinitionExtendibleEnumeration, Serializable, XMLSerializable, MAJCommon
extends TypeDefinition
implements TypeDefinitionExtendibleEnumeration, Serializable, XMLSerializable, MAJCommon

Implements the definition of a property type that can have one of an extendible set of AUID values.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:: Richard Cartwright
See Also:: Serialized Form

Nested Class Summary
`static class`	`TypeDefinitionExtendibleEnumeration.ElementXMLHandler`
`static class`	`TypeDefinitionExtendibleEnumeration.ExtendibleEnumerationValue`
`static class`	`TypeDefinitionExtendibleEnumeration.XMLHandler`

Field Summary
`static TypeDefinitionExtendibleEnumeration`	`CodingEquationsType`
`static TypeDefinitionExtendibleEnumeration`	`ColorPrimariesType`
`static TypeDefinitionExtendibleEnumeration`	`OperationCategoryType`
`static TypeDefinitionExtendibleEnumeration`	`PluginCategoryType`
`static TypeDefinitionExtendibleEnumeration`	`TransferCharacteristicType`
`static TypeDefinitionExtendibleEnumeration`	`UsageType`

Constructor Summary
`TypeDefinitionExtendibleEnumeration(AUID identification, String typeName, SortedMap<String,AUID> elements)` Creates and initializes the new extensible enumeration type definition, which defines a property type that can have one of an extendible set of AUID values.

Method Summary
`void`	`appendElement(AUID value, String name)` Appends the given element, a name and AUID pair, to this extendible enumeration type definition.
`void`	`appendXMLChildren(Node parent)` Append child elements to the given parent node to serialize the value of an object to an XML fragment.
`int`	`countElements()` Returns the number of enumeration elements of this extendible enumeration type definition.
`PropertyValue`	`createValue(Object javaValue)` Create a property value from the given Java object.
`PropertyValue`	`createValueFromName(String name)` Creates a property value defined by this extendible enumeration type definition using the given name.
`boolean`	`deepEquals(Object o)` Check to see if this definition is equal to the given object by comparing each property.
`AUID`	`getAUIDFromName(String name)` Returns the identifier of the enumeration element associated with the given name, as defined by this extendible enumeration type definition.
`AUID`	`getAUIDValue(PropertyValue enumerationProperty)` Returns the AUID value associated with the given extendible enumeration property value according to this extendible enumeration type definition.
`String`	`getElementName(int index)` Returns the name of the enumeration element at the given index in the list of elements of this extendible enumeration type definition.
`String[]`	`getElementNames()`
`AUID`	`getElementValue(int index)` Returns the AUID value for the enumeration element at the given index of in the list of elements of this extendible enumeration type definition.
`AUID[]`	`getElementValues()`
`String`	`getNameFromAUID(AUID value)` Returns the name of the enumeration element associated with the given AUID value, as defined by this extendible enumeration type definition.
`String`	`getNameFromValue(PropertyValue enumerationProperty)` Returns the name associated with the given property value, as defined by this extendible enumeration type definition.
`TypeCategory`	`getTypeCategory()` Returns the type category to which this type definition belongs, which corresponds to its sub interface.
`void`	`setAUIDValue(PropertyValue enumerationProperty, AUID value)` Sets the value of the given extendible enumeration property value to the given AUID that identifies an element of this extendible enumeration type definition.
`void`	`setPropertiesFromInterface(TypeDefinitionExtendibleEnumeration castFrom)`

Methods inherited from class tv.amwa.maj.meta.TypeDefinition
`setPropertiesFromInterface`

Methods inherited from class tv.amwa.maj.meta.MetaDefinition
`castFromInterface, equals, getAUID, getDescription, getIdentification, getName, hashCode, setDescription, setName, setPropertiesFromInterface, toString`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface tv.amwa.maj.iface.MetaDefinition
`getAUID, getDescription, getName, setDescription, setName`

Methods inherited from interface tv.amwa.maj.meta.MAJCommon
`equals, hashCode, toString`

Field Detail

OperationCategoryType

public static final TypeDefinitionExtendibleEnumeration OperationCategoryType

TransferCharacteristicType

public static final TypeDefinitionExtendibleEnumeration TransferCharacteristicType

PluginCategoryType

public static final TypeDefinitionExtendibleEnumeration PluginCategoryType

UsageType

public static final TypeDefinitionExtendibleEnumeration UsageType

ColorPrimariesType

public static final TypeDefinitionExtendibleEnumeration ColorPrimariesType

CodingEquationsType

public static final TypeDefinitionExtendibleEnumeration CodingEquationsType

Constructor Detail

TypeDefinitionExtendibleEnumeration

public TypeDefinitionExtendibleEnumeration(AUID identification,
                                           @AAFString
                                           String typeName,
                                           SortedMap<String,AUID> elements)
                                    throws NullPointerException,
                                           DuplicateException

Creates and initializes the new extensible enumeration type definition, which defines a property type that can have one of an extendible set of AUID values. The initial set of (possibly empty) elements must be provided as a map from element name to AUID. Further enumeration elements can then be specified using the appendElement(AUID, String) method.

Creating new and unregistered type definitions is not recommended as this may cause interoperability issues with other systems. The official registry of type definitions is available from SMPTE at SMPTE Metadata Registries And Related Items. The full range of data types documented in the AAF 1.1 object specification can be accessed by name and identification using either AAFFactory.typeDefinitionForName(String) or AAFFactory.typeDefinitionForIdentification(tv.amwa.maj.record.AUID) respectively.

Parameters:: identification - AUID to be used to identify this type.; typeName - Friendly name of the type definition.; elements - Map containing element names and the AUIDs they map to.
Throws:: NullPointerException - One or more of the arguments is null.; DuplicateException - The given representation of an extendible enumeration contains duplicate AUID values.
See Also:: ExtendibleEnumerationWarehouse, ExtendibleEnumerationItem

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(TypeDefinitionExtendibleEnumeration castFrom)

See Also:: MetaDefinition.setPropertiesFromInterface(tv.amwa.maj.iface.MetaDefinition)

getElementNames

@AAFProperty(uuid1=50397699,
             uuid2=1792,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="ElementNames",
             typeName="StringArray",
             optional=false,
             uniqueIdentifier=false,
             pid=31)
public String[] getElementNames()