tv.amwa.maj.entity
Class Dictionary

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.Dictionary

All Implemented Interfaces:

Serializable, Cloneable, MAJCommon, Dictionary, InterchangeObject, XMLSerializable

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=8704,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="Dictionary",
          description="The Dictionary class has DefinitionObject objects.")
public class Dictionary
extends InterchangeObject
implements Dictionary, Serializable, Cloneable, MAJCommon

Implements a container for definitions. The dictionary specified here is both an AAF Dictionary and an AAF MetaDictionary. Every AAF file has a dictionary within its header and contains a representation of the meta dictionary.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class	Dictionary.CodecDefinitionsXMLHandler
static class	Dictionary.ContainerDefinitionsXMLHandler
static class	Dictionary.DataDefinitionsXMLHandler
static class	Dictionary.InterpolationDefinitionsXMLHandler
static class	Dictionary.KLVDataDefinitionsXMLHandler
static class	Dictionary.OperationDefinitionsXMLHandler
static class	Dictionary.ParameterDefinitionsXMLHandler
static class	Dictionary.PluginDefinitionsXMLHandler
static class	Dictionary.TaggedValueDefinitionsXMLHandler
static class	Dictionary.XMLHandler

Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject

InterchangeObject.InterchangeObjectXMLHandler

Field Summary

static String

DICTIONARY_TAG

Constructor Summary

Dictionary()
Creates and initializes a new dictionary object, which has the definition objects of an AAF persistent unit.

Method Summary

void	appendXMLChildren(Node parent) Append child elements to the given parent node to serialize the value of an object to an XML fragment.
Dictionary	clone() Creates a cloned copy of this entity.
int	countClassDefinitions() Returns the number of class definitions contained in this dictionary.
int	countCodecDefinitions() Returns the number of codec definitions contained in this dictionary.
int	countContainerDefinitions() Returns the number of container definitions contained in this dictionary.
int	countDataDefinitions() Returns the number of data definitions contained in this dictionary.
int	countInterpolationDefinitions() Returns the number of interpolation definitions contained in this dictionary.
int	countKLVDataDefinitions() Returns the number of KLV data definitions contained in this dictionary.
int	countOpaqueTypeDefinitions() Returns the number of opaque type definitions in the dictionary.
int	countOperationDefinitions() Returns the number of operation definitions contained in this dictionary.
int	countParameterDefinitions() Returns the number of parameter definitions contained in this dictionary.
int	countPluginDefinitions() Returns the number of plugin definitions contained in this dictionary.
int	countTaggedValueDefinitions() Returns the number of tagged value definitions contained in this dictionary.
int	countTypeDefinitions() Returns the number of type definitions contained in the dictionary.
void	createForwardClassReference(AUID classId) Creates a forward class reference that is used to allow a class definition to be referenced before it has had its full definition stored into this dictionary.
InterchangeObject	createInstance(AUID identification) Creates a single uninitialized AAF object of the class associated with a specified stored object id.
MetaDefinition	createMetaInstance(AUID identification) Creates a single uninitialized AAF meta class or type associated with a specified stored object id.
Set<ClassDefinition>	getClassDefinitions() Returns the set of all class definitions in this dictionary.
Set<CodecDefinition>	getCodecDefinitions() Returns a set of all the codec definitions contained in the dictionary.
Set<ContainerDefinition>	getContainerDefinitions() Returns the set of all container definitions contained in this dictionary.
Set<DataDefinition>	getDataDefinitions() Returns the set of data definitions contained in this dictionary.
long	getId()
Set<InterpolationDefinition>	getInterpolationDefinitions() Returns the set of interpolation definitions contained in this dictionary.
Set<KLVDataDefinition>	getKLVDataDefinitions() Returns the set of KLV data definitions contained in this dictionary.
Set<TypeDefinition>	getOpaqueTypeDefinitions() Return the set of all registered opaque type definitions in the dictionary.
Set<OperationDefinition>	getOperationDefinitions() Returns the set of operation definitions contained in this dictionary.
Set<ParameterDefinition>	getParameterDefinitions() Returns the set of parameter definitions contained in this dictionary.
Set<PluginDefinition>	getPluginDefinitions() Returns the set of plugin definitions contained in this dictionary.
Set<TaggedValueDefinition>	getTaggedValueDefinitions() Returns a set of all tagged value definitions contained in this dictionary.
Set<TypeDefinition>	getTypeDefinitions() Returns the set of all type definitions contained within this dictionary.
boolean	hasForwardClassReference(AUID classId) Returns true if the given class identification is a forward reference registered with this dictionary.
DataDefinition	lookupAuxiliaryDataDefinition() Returns the auxiliary data definition.
ClassDefinition	lookupClassDefinition(AUID id) Returns the class definition with the given identifier that is contained in this dictionary.
CodecDefinition	lookupCodecDefinition(AUID codecId) Returns the codec definition with the given identifier that is contained in this dictionary.
ContainerDefinition	lookupContainerDefinition(AUID containerId) Returns the container definition with the given identifier that is contained in this dictionary.
DataDefinition	lookupDataDefinition(AUID dataDefinitionId) Return the data definition with the given identifier that is contained in this dictionary.
DataDefinition	lookupDescriptiveMedadataDataDefinition() Returns the descriptive metadata data definition.
DataDefinition	lookupEdgecodeDataDefinition() Returns the edgecode data definition.
InterpolationDefinition	lookupInterpoliationDefinition(AUID interpolationId) Returns the interpolation definition with the given identifier that is contained in this dictionary.
KLVDataDefinition	lookupKLVDataDefinition(AUID defId) Returns the KLV data definition with the given identifier that is contained in this dictionary
DataDefinition	lookupLegacyPictureDataDefinition() Returns the legacy picture data definition.
DataDefinition	lookupLegacySoundDataDefinition() Returns the legacy sound data definition.
DataDefinition	lookupLegacyTimecodeDataDefinition() Returns the legacy timecode data definition.
DataDefinition	lookupMatteDataDefinition() Returns the matte data definition.
TypeDefinition	lookupOpaqueTypeDefinition(AUID typeId) Return the opaque type definition with the given id.
OperationDefinition	lookupOperationDefinition(AUID operationId) Return the operation definition with the given identifier that is contained in this dictionary.
ParameterDefinition	lookupParameterDefinition(AUID parameterId) Returns the parameter definition with the given identifier that is contained in this dictionary.
DataDefinition	lookupPictureDataDefinition() Returns the picture data definition.
DataDefinition	lookupPictureWithMatteDataDefinition() Returns the picture with matte data definition.
PluginDefinition	lookupPluginDefinition(AUID pluginId) Return the plugin definition with the given identifier that is contained in this dictionary.
DataDefinition	lookupSoundDataDefinition() Returns a sound data definition.
TaggedValueDefinition	lookupTaggedValueDefinition(AUID defId) Returns the tagged value definition with the given identifier that is contained in this dictionary.
DataDefinition	lookupTimecodeDataDefinition() Returns the timecode data definition.
TypeDefinition	lookupTypeDefinition(AUID id) Return the type definition with the given identifier that is contained within this dictionary.
void	registerClassDefinition(ClassDefinition classDef) Add a class definition to those contained in this dictionary.
void	registerCodecDefinition(CodecDefinition codecDef) Add a codec definition to those contained in this dictionary.
void	registerContainerDefinition(ContainerDefinition containerDefinition) Add a container definition to those contained in this dictionary.
void	registerDataDefinition(DataDefinition dataDef) Add a data definition to the those contained in this dictionary.
void	registerInterpolationDefinition(InterpolationDefinition interpolationDefinition) Add an interpolation definition to those contained in this dictionary.
void	registerKLVDataDefinition(KLVDataDefinition klvDataDefinition) Add a KLV data definition to those contained in the dictionary.
void	registerKLVDataKey(AUID uid, TypeDefinition typeDef) Add the definition for the given KLV key to the runtime dictionary.
void	registerOpaqueTypeDefinition(TypeDefinition typeDef) Add the opaque type definition to the dictionary.
void	registerOperationDefinition(OperationDefinition operationDefinition) Add a operation definition to those contained in the dictionary.
void	registerParameterDefinition(ParameterDefinition parameterDefinition) Add a parameter definition to those contained in the dictionary.
void	registerPluginDefinition(PluginDefinition pluginDefinition) Add a plugin definition to those contained in this dictionary.
void	registerTaggedValueDefinition(TaggedValueDefinition def) Add the tagged value definition to those contained in this dictionary.
void	registerTypeDefinition(TypeDefinition typeDef) Add a type definition to those contained in this dictionary.
void	setId(long id)
void	setPropertiesFromInterface(Dictionary castFrom)

Methods inherited from class tv.amwa.maj.entity.InterchangeObject

castFromInterface, countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, registerImplementation, setPropertiesFromInterface, setPropertyValue, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface tv.amwa.maj.iface.InterchangeObject

countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue

Methods inherited from interface tv.amwa.maj.entity.MAJCommon

equals, hashCode, toString

Field Detail

DICTIONARY_TAG

public static final String DICTIONARY_TAG

See Also:

Constant Field Values

Constructor Detail

Dictionary

public Dictionary()

Creates and initializes a new dictionary object, which has the definition objects of an AAF persistent unit. All the sets of items in the dictionary are initialized to empty sets.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(Dictionary castFrom)

countClassDefinitions

public int countClassDefinitions()

Description copied from interface: Dictionary

Returns the number of class definitions contained in this dictionary.

Specified by:

countClassDefinitions in interface Dictionary

Returns:

Number of class definitions contained in this dictionary.

countCodecDefinitions

public int countCodecDefinitions()

Description copied from interface: Dictionary

Returns the number of codec definitions contained in this dictionary.

Specified by:

countCodecDefinitions in interface Dictionary

Returns:

Number of codec definitions contained in this dictionary.

countContainerDefinitions

public int countContainerDefinitions()

Description copied from interface: Dictionary

Returns the number of container definitions contained in this dictionary.

Specified by:

countContainerDefinitions in interface Dictionary

Returns:

Number of container definitions contained in this dictionary.

countDataDefinitions

public int countDataDefinitions()

Description copied from interface: Dictionary

Returns the number of data definitions contained in this dictionary.

Specified by:

countDataDefinitions in interface Dictionary

Returns:

Number of data definitions contained in this dictionary.

countInterpolationDefinitions

public int countInterpolationDefinitions()

Description copied from interface: Dictionary

Returns the number of interpolation definitions contained in this dictionary.

Specified by:

countInterpolationDefinitions in interface Dictionary

Returns:

Number of interpolation definitions contained in this dictionary.

countKLVDataDefinitions

public int countKLVDataDefinitions()

Description copied from interface: Dictionary

Returns the number of KLV data definitions contained in this dictionary.

Specified by:

countKLVDataDefinitions in interface Dictionary

Returns:

Number of KLV data definitions contained in this dictionary.

countOpaqueTypeDefinitions

public int countOpaqueTypeDefinitions()

Description copied from interface: Dictionary

Returns the number of opaque type definitions in the dictionary.

Specified by:

countOpaqueTypeDefinitions in interface Dictionary

Returns:

Number of opaque type definitions.

countOperationDefinitions

public int countOperationDefinitions()

Description copied from interface: Dictionary

Returns the number of operation definitions contained in this dictionary.

Specified by:

countOperationDefinitions in interface Dictionary

Returns:

Number of operation definitions contained in this dictionary.

countParameterDefinitions

public int countParameterDefinitions()

Description copied from interface: Dictionary

Returns the number of parameter definitions contained in this dictionary.

Specified by:

countParameterDefinitions in interface Dictionary

Returns:

Number of parameter definitions contained in this dictionary.

countPluginDefinitions

public int countPluginDefinitions()

Description copied from interface: Dictionary

Returns the number of plugin definitions contained in this dictionary.

Specified by:

countPluginDefinitions in interface Dictionary

Returns:

Number of plugin definitions contained in this dictionary.

countTaggedValueDefinitions

public int countTaggedValueDefinitions()

Description copied from interface: Dictionary

Returns the number of tagged value definitions contained in this dictionary.

Specified by:

countTaggedValueDefinitions in interface Dictionary

Returns:

Number of tagged value definitions contained in the dictionary.

countTypeDefinitions

public int countTypeDefinitions()

Description copied from interface: Dictionary

Returns the number of type definitions contained in the dictionary.

Specified by:

countTypeDefinitions in interface Dictionary

Returns:

Number of type definitions in this dictionary.

createForwardClassReference

public void createForwardClassReference(AUID classId)
                                 throws InvalidParameterException

Description copied from interface: Dictionary

Creates a forward class reference that is used to allow a class definition to be referenced before it has had its full definition stored into this dictionary.

Specified by:

createForwardClassReference in interface Dictionary

Parameters:

classId - Unique class identifier for the forward reference.

Throws:

InvalidParameterException - The given ID represents an existing forward class reference or a class definition that has already been successfully registered.

createInstance

public InterchangeObject createInstance(AUID identification)
                                 throws NotImplementedException

Description copied from interface: Dictionary

Creates a single uninitialized AAF object of the class associated with a specified stored object id. This method is not implemented in the MAJ API as it is not possible to create an uninitialized object. This methods always throws an NotImplementedException and the functionality is replaced by the AAF factory.

This method is a factory for creating objects found within an AAF file.

Specified by:

createInstance in interface Dictionary

Parameters:

identification - Class identifier (id) of the stored object. This is the corresponding SMPTE identifier (as a GUID) for all predefined built-in classes.

Returns:

Object that is an instance of the specified class and implements the specified interface.

Throws:

NotImplementedException - This method is not implemented in the MAJ API.

See Also:

AAFFactory

createMetaInstance

public MetaDefinition createMetaInstance(AUID identification)
                                  throws NotImplementedException

Description copied from interface: Dictionary

Creates a single uninitialized AAF meta class or type associated with a specified stored object id. This method is not implemented in the MAJ API as it is not possible to create an uninitialized object. This methods always throws an NotImplementedException and the functionality is replaced by the AAF factory.

Specified by:

createMetaInstance in interface Dictionary

Parameters:

identification - Identifier (id) of a class or type definition. This is the corresponding SMPTE identifier (as a GUID) for all predefined built-in definitions.

Returns:

Instantiated metaclass.

Throws:

NotImplementedException - This method is not implemented in the MAJ API.

See Also:

AAFFactory

getClassDefinitions

@AAFProperty(uuid1=100729095,
             uuid2=1792,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="ClassDefinitions",
             typeName="StrongReferenceSet of ClassDefinition",
             optional=true,
             uniqueIdentifier=false,
             pid=3)
public Set<ClassDefinition> getClassDefinitions()

Description copied from interface: Dictionary

Returns the set of all class definitions in this dictionary.

Specified by:

getClassDefinitions in interface Dictionary

Returns:

Shallow copy of the set of all class definitions contained in this dictionary.

getCodecDefinitions

@AAFProperty(uuid1=100729092,
             uuid2=1287,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="CodecDefinitions",
             typeName="StrongReferenceSet of CodecDefinition",
             optional=true,
             uniqueIdentifier=false,
             pid=9735)
public Set<CodecDefinition> getCodecDefinitions()

Description copied from interface: Dictionary

Returns a set of all the codec definitions contained in the dictionary.

Specified by:

getCodecDefinitions in interface Dictionary

Returns:

Shallow copy of the set of codec definitions contained in this dictionary.

getContainerDefinitions

@AAFProperty(uuid1=100729092,
             uuid2=1288,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="ContainerDefinitions",
             typeName="StrongReferenceSet of ContainerDefinition",
             optional=true,
             uniqueIdentifier=false,
             pid=9736)
public Set<ContainerDefinition> getContainerDefinitions()

Description copied from interface: Dictionary

Returns the set of all container definitions contained in this dictionary.

Specified by:

getContainerDefinitions in interface Dictionary

Returns:

Shallow copy of the set of container definitions.

getDataDefinitions

@AAFProperty(uuid1=100729092,
             uuid2=1285,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="DataDefinitions",
             typeName="StrongReferenceSet of DataDefinition",
             optional=true,
             uniqueIdentifier=false,
             pid=9733)
public Set<DataDefinition> getDataDefinitions()

Description copied from interface: Dictionary

Returns the set of data definitions contained in this dictionary.

Specified by:

getDataDefinitions in interface Dictionary

Returns:

Shallow copy of the set of data definitions contained in this dictionary.

getInterpolationDefinitions

@AAFProperty(uuid1=100729092,
             uuid2=1289,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="InterpolationDefinitions",
             typeName="StrongReferenceSet of InterpolationDefinition",
             optional=true,
             uniqueIdentifier=false,
             pid=9737)
public Set<InterpolationDefinition> getInterpolationDefinitions()

Description copied from interface: Dictionary

Returns the set of interpolation definitions contained in this dictionary.

Specified by:

getInterpolationDefinitions in interface Dictionary

Returns:

Shallow copy of the set of interpolation definitions contained in this dictionary.

getKLVDataDefinitions

@AAFProperty(uuid1=100729092,
             uuid2=1290,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,7},
             definedName="KLVDataDefinitions",
             typeName="StrongReferenceSet of KLVDataDefinition",
             optional=true,
             uniqueIdentifier=false,
             pid=9738)
public Set<KLVDataDefinition> getKLVDataDefinitions()

Description copied from interface: Dictionary

Returns the set of KLV data definitions contained in this dictionary.

Specified by:

getKLVDataDefinitions in interface Dictionary

Returns:

Shallow copy of the set of KLV data definitions contained in this dictionary.

getOpaqueTypeDefinitions

public Set<TypeDefinition> getOpaqueTypeDefinitions()

Description copied from interface: Dictionary

Return the set of all registered opaque type definitions in the dictionary.

Specified by:

getOpaqueTypeDefinitions in interface Dictionary

Returns:

Iterator over the set of all registered opaque type definitions.

getOperationDefinitions

@AAFProperty(uuid1=100729092,
             uuid2=1283,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="OperationDefinitions",
             typeName="StrongReferenceSet of OperationDefinition",
             optional=true,
             uniqueIdentifier=false,
             pid=9731)
public Set<OperationDefinition> getOperationDefinitions()

Description copied from interface: Dictionary

Returns the set of operation definitions contained in this dictionary.

Specified by:

getOperationDefinitions in interface Dictionary

Returns:

Shallow copy of the set of operation definitions contained in this dictionary.

getParameterDefinitions

@AAFProperty(uuid1=100729092,
             uuid2=1284,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="ParameterDefinitions",
             typeName="StrongReferenceSet of ParameterDefinition",
             optional=true,
             uniqueIdentifier=false,
             pid=9732)
public Set<ParameterDefinition> getParameterDefinitions()

Description copied from interface: Dictionary

Returns the set of parameter definitions contained in this dictionary.

Specified by:

getParameterDefinitions in interface Dictionary

Returns:

Shallow copy of the set of parameter definitions contained in this dictionary.

getPluginDefinitions

@AAFProperty(uuid1=100729092,
             uuid2=1286,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="PluginDefinitions",
             typeName="StrongReferenceSet of PluginDefinition",
             optional=true,
             uniqueIdentifier=false,
             pid=9734)
public Set<PluginDefinition> getPluginDefinitions()

Description copied from interface: Dictionary

Returns the set of plugin definitions contained in this dictionary.

Specified by:

getPluginDefinitions in interface Dictionary

Returns:

Shallow copy of the set of plugin definitions contained in this dictionary.

getTaggedValueDefinitions

@AAFProperty(uuid1=100729092,
             uuid2=1291,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,7},
             definedName="TaggedValueDefinitions",
             typeName="StrongReferenceSet of TaggedValueDefinition",
             optional=true,
             uniqueIdentifier=false,
             pid=9739)
public Set<TaggedValueDefinition> getTaggedValueDefinitions()

Description copied from interface: Dictionary

Returns a set of all tagged value definitions contained in this dictionary.

Specified by:

getTaggedValueDefinitions in interface Dictionary

Returns:

Shallow copy of the set the tagged value definitions contained in this dictionary.

getTypeDefinitions

@AAFProperty(uuid1=100729095,
             uuid2=2048,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="TypeDefinitions",
             typeName="StrongReferenceSet of TypeDefinition",
             optional=true,
             uniqueIdentifier=false,
             pid=4)
public Set<TypeDefinition> getTypeDefinitions()

Description copied from interface: Dictionary

Returns the set of all type definitions contained within this dictionary.

Specified by:

getTypeDefinitions in interface Dictionary

Returns:

Shallow copy of the set of type definitions contained in this dictionary.

hasForwardClassReference

public boolean hasForwardClassReference(AUID classId)
                                 throws InvalidParameterException

Description copied from interface: Dictionary

Returns true if the given class identification is a forward reference registered with this dictionary.

Specified by:

hasForwardClassReference in interface Dictionary

Parameters:

classId - Unique class identifier.

Returns:

Has the class got a forward reference in this dictionary?

Throws:

InvalidParameterException - The given ID is not recognized as a class definition id.

lookupAuxiliaryDataDefinition

public DataDefinition lookupAuxiliaryDataDefinition()

Description copied from interface: Dictionary

Returns the auxiliary data definition. This is a built-in data definition for auxiliary data.

Specified by:

lookupAuxiliaryDataDefinition in interface Dictionary

Returns:

Auxiliary data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.Auxiliary

lookupClassDefinition

public ClassDefinition lookupClassDefinition(AUID id)
                                      throws NullPointerException,
                                             InvalidParameterException

Description copied from interface: Dictionary

Returns the class definition with the given identifier that is contained in this dictionary.

Specified by:

lookupClassDefinition in interface Dictionary

Parameters:

id - Unique identifier for a class contained in this dictionary.

Returns:

Class definition with the given identification that is contained in this dictionary.

Throws:

NullPointerException - Argument is null.

InvalidParameterException - The given class identifier does not match a class definition stored in this dictionary.

See Also:

ClassDefinitionWarehouse.forClass(Class), AAFClass

lookupCodecDefinition

public CodecDefinition lookupCodecDefinition(AUID codecId)
                                      throws NullPointerException,
                                             InvalidParameterException

Description copied from interface: Dictionary

Returns the codec definition with the given identifier that is contained in this dictionary.

Specified by:

lookupCodecDefinition in interface Dictionary

Parameters:

codecId - Identifier for a codec definition contained in this dictionary.

Returns:

Codec definition with the given identifier contained in this dictionary.

Throws:

NullPointerException - The given identifier is null.

InvalidParameterException - The given identifier does not match a codec definition contained in this dictionary.

lookupContainerDefinition

public ContainerDefinition lookupContainerDefinition(AUID containerId)
                                              throws NullPointerException,
                                                     InvalidParameterException

Description copied from interface: Dictionary

Returns the container definition with the given identifier that is contained in this dictionary.

Specified by:

lookupContainerDefinition in interface Dictionary

Parameters:

containerId - Identifier for a container definition contained in this dictionary.

Returns:

Container definition contained in this dictionary with the given id.

Throws:

NullPointerException - The given identifier is null.

InvalidParameterException - The given identifier does not match a codec definition contained in this dictionary.

lookupDataDefinition

public DataDefinition lookupDataDefinition(AUID dataDefinitionId)
                                    throws NullPointerException,
                                           InvalidParameterException

Description copied from interface: Dictionary

Return the data definition with the given identifier that is contained in this dictionary.

Specified by:

lookupDataDefinition in interface Dictionary

Parameters:

dataDefinitionId - Unique identifier for a data definition contained in this dictionary.

Returns:

Data definition contained in this dictionary with the given identifier.

Throws:

NullPointerException - The given identifier is null.

InvalidParameterException - A data definition with the given id could not be found in this dictionary.

lookupDescriptiveMedadataDataDefinition

public DataDefinition lookupDescriptiveMedadataDataDefinition()

Description copied from interface: Dictionary

Returns the descriptive metadata data definition. This is a built-in data definition for descriptive metadata.

Specified by:

lookupDescriptiveMedadataDataDefinition in interface Dictionary

Returns:

Descriptive metadata data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.DescriptiveMetadata

lookupEdgecodeDataDefinition

public DataDefinition lookupEdgecodeDataDefinition()

Description copied from interface: Dictionary

Returns the edgecode data definition. This is a built-in data definition for a stream of film edge code values.

Specified by:

lookupEdgecodeDataDefinition in interface Dictionary

Returns:

Edgecode data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.Edgecode

lookupInterpoliationDefinition

public InterpolationDefinition lookupInterpoliationDefinition(AUID interpolationId)
                                                       throws NullPointerException,
                                                              InvalidParameterException

Description copied from interface: Dictionary

Returns the interpolation definition with the given identifier that is contained in this dictionary.

Specified by:

lookupInterpoliationDefinition in interface Dictionary

Parameters:

interpolationId - Identifier for an interpolation definition contained in this dictionary.

Returns:

Interpolation definition with the given identifier contained in this dictionary.

Throws:

NullPointerException - The given identifier is null.

InvalidParameterException - The given identifier does not match that of an interpolation definition contained in this dictionary.

lookupKLVDataDefinition

public KLVDataDefinition lookupKLVDataDefinition(AUID defId)
                                          throws NullPointerException,
                                                 InvalidParameterException

Description copied from interface: Dictionary

Returns the KLV data definition with the given identifier that is contained in this dictionary

Specified by:

lookupKLVDataDefinition in interface Dictionary

Parameters:

defId - Identifier for a KLV data definition contained in this dictionary.

Returns:

KLV data definition with the given identifier contained in this dictionary.

Throws:

NullPointerException - The given KLV data definition is null.

InvalidParameterException - The given id does not match that of a KLV data definition in the dictionary.

lookupLegacyPictureDataDefinition

public DataDefinition lookupLegacyPictureDataDefinition()

Description copied from interface: Dictionary

Returns the legacy picture data definition. This is a built-in data definition for a stream of essence that contains image data.

Specified by:

lookupLegacyPictureDataDefinition in interface Dictionary

Returns:

Legacy picture data definition.

See Also:

DataDefinitionConstant.LegacyPicture

lookupLegacySoundDataDefinition

public DataDefinition lookupLegacySoundDataDefinition()

Description copied from interface: Dictionary

Returns the legacy sound data definition. This is a built-in data definition essence that contains a single channel of sound.

Specified by:

lookupLegacySoundDataDefinition in interface Dictionary

Returns:

Legacy sound data definition.

See Also:

DataDefinitionConstant.LegacySound

lookupLegacyTimecodeDataDefinition

public DataDefinition lookupLegacyTimecodeDataDefinition()

Description copied from interface: Dictionary

Returns the legacy timecode data definition. This is a built-in data definition for a stream of tape timecode values.

Specified by:

lookupLegacyTimecodeDataDefinition in interface Dictionary

Returns:

Legacy timecode data definition.

See Also:

DataDefinitionConstant.LegacyTimecode

lookupMatteDataDefinition

public DataDefinition lookupMatteDataDefinition()

Description copied from interface: Dictionary

Returns the matte data definition. This is a built-in data definition for a stream of essence that contains alpha values.

Specified by:

lookupMatteDataDefinition in interface Dictionary

Returns:

Matte data definition.

See Also:

DataDefinitionConstant.Matte

lookupOpaqueTypeDefinition

public TypeDefinition lookupOpaqueTypeDefinition(AUID typeId)
                                          throws NullPointerException,
                                                 InvalidParameterException

Description copied from interface: Dictionary

Return the opaque type definition with the given id.

Specified by:

lookupOpaqueTypeDefinition in interface Dictionary

Parameters:

typeId - Unique type ID.

Returns:

Corresponding type definition.

Throws:

NullPointerException - Argument is null.

InvalidParameterException - The given ID is not recognized as a type definition ID.

lookupOperationDefinition

public OperationDefinition lookupOperationDefinition(AUID operationId)
                                              throws NullPointerException,
                                                     InvalidParameterException

Description copied from interface: Dictionary

Return the operation definition with the given identifier that is contained in this dictionary.

Specified by:

lookupOperationDefinition in interface Dictionary

Parameters:

operationId - Identifier of an operation definition contained in this dictionary.

Returns:

Operation definition with the given id contained in this dictionary.

Throws:

NullPointerException - The given identifier is null.

InvalidParameterException - The given identifier does not match that of an operation definition contained in this dictionary.

lookupParameterDefinition

public ParameterDefinition lookupParameterDefinition(AUID parameterId)
                                              throws NullPointerException,
                                                     InvalidParameterException

Description copied from interface: Dictionary

Returns the parameter definition with the given identifier that is contained in this dictionary.

Specified by:

lookupParameterDefinition in interface Dictionary

Parameters:

parameterId - Identifier for a parameter definition contained in this dictionary.

Returns:

Parameter definition with the given identifier contained in this dictionary.

Throws:

NullPointerException - The given identifier is null.

InvalidParameterException - The given identifier does not match a parameter definition contained in this dictionary.

lookupPictureDataDefinition

public DataDefinition lookupPictureDataDefinition()

Description copied from interface: Dictionary

Returns the picture data definition. This is a built-in data definition for a stream of essence that contains image data.

Specified by:

lookupPictureDataDefinition in interface Dictionary

Returns:

Picture data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.Picture

lookupPictureWithMatteDataDefinition

public DataDefinition lookupPictureWithMatteDataDefinition()

Description copied from interface: Dictionary

Returns the picture with matte data definition. This is a built-in data definition for a stream of essence that contains image data and a matte.

Specified by:

lookupPictureWithMatteDataDefinition in interface Dictionary

Returns:

Picture with matte data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.PictureWithMatte

lookupPluginDefinition

public PluginDefinition lookupPluginDefinition(AUID pluginId)
                                        throws NullPointerException,
                                               InvalidParameterException

Description copied from interface: Dictionary

Return the plugin definition with the given identifier that is contained in this dictionary.

Specified by:

lookupPluginDefinition in interface Dictionary

Parameters:

pluginId - Identifier for a plugin definition contained in this dictionary.

Returns:

Plugin definition with the given identifier contained in this dictionary.

Throws:

NullPointerException - The given identifier is null.

InvalidParameterException - The given identifier does not match that of a plugin definition contained in this dictionary.

lookupSoundDataDefinition

public DataDefinition lookupSoundDataDefinition()

Description copied from interface: Dictionary

Returns a sound data definition. This is a built-in data definition for a a stream of essence that contains a single channel of sound.

Specified by:

lookupSoundDataDefinition in interface Dictionary

Returns:

Sound data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.Sound

lookupTimecodeDataDefinition

public DataDefinition lookupTimecodeDataDefinition()

Description copied from interface: Dictionary

Returns the timecode data definition. This is a built-in data definition for a stream of tape timecode values.

Specified by:

lookupTimecodeDataDefinition in interface Dictionary

Returns:

Timecode data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.Timecode

lookupTaggedValueDefinition

public TaggedValueDefinition lookupTaggedValueDefinition(AUID defId)
                                                  throws NullPointerException,
                                                         InvalidParameterException

Description copied from interface: Dictionary

Returns the tagged value definition with the given identifier that is contained in this dictionary.

Specified by:

lookupTaggedValueDefinition in interface Dictionary

Parameters:

defId - ID of the tagged value definition to lookup in the dictionary.

Returns:

Matching tagged value definition in the dictionary.

Throws:

NullPointerException - The given identifier is null.

InvalidParameterException - The given identifier does not match that of a tagged value definition contained in this dictionary.

lookupTypeDefinition

public TypeDefinition lookupTypeDefinition(AUID id)
                                    throws NullPointerException,
                                           InvalidParameterException

Description copied from interface: Dictionary

Return the type definition with the given identifier that is contained within this dictionary.

Specified by:

lookupTypeDefinition in interface Dictionary

Parameters:

id - Unique identifier for the type definition contained in this dictionary.

Returns:

Type definition in this dictionary with the given type id.

Throws:

NullPointerException - The given type identifier is null.

InvalidParameterException - The given identifier does not match that of a type definition contained in this dictionary.

registerClassDefinition

public void registerClassDefinition(ClassDefinition classDef)
                             throws InvalidParameterException,
                                    NullPointerException

Description copied from interface: Dictionary

Add a class definition to those contained in this dictionary.

Specified by:

registerClassDefinition in interface Dictionary

Parameters:

classDef - Class definition to add.

Throws:

InvalidParameterException - A class definition with the same identifier is already contained in this dictionary.

NullPointerException - The given class definition is null.

See Also:

AAFFactory.classDefinitionForClass(Class), AAFFactory.classDefinitionForName(String), ClassDefinitionWarehouse

registerCodecDefinition

public void registerCodecDefinition(CodecDefinition codecDef)
                             throws NullPointerException,
                                    InvalidParameterException

Description copied from interface: Dictionary

Add a codec definition to those contained in this dictionary.

Specified by:

registerCodecDefinition in interface Dictionary

Parameters:

codecDef - Codec definition to add.

Throws:

NullPointerException - The given codec definition is null.

InvalidParameterException - A codec definition with the same identifier is already contained in this dictionary.

See Also:

CodecConstant, CodecDefinition.forName(String), CodecDefinition.forIdentification(AUID)

registerContainerDefinition

public void registerContainerDefinition(ContainerDefinition containerDefinition)
                                 throws NullPointerException,
                                        InvalidParameterException

Description copied from interface: Dictionary

Add a container definition to those contained in this dictionary.

Specified by:

registerContainerDefinition in interface Dictionary

Parameters:

containerDefinition - Container definition to add.

Throws:

NullPointerException - The given container definition is null.

InvalidParameterException - A container definition with the same identifier is already contained in this dictionary.

See Also:

ContainerConstant, ContainerDefinition.forName(String), ContainerDefinition.forIdentification(AUID)

registerDataDefinition

public void registerDataDefinition(DataDefinition dataDef)
                            throws NullPointerException,
                                   InvalidParameterException

Description copied from interface: Dictionary

Add a data definition to the those contained in this dictionary.

Specified by:

registerDataDefinition in interface Dictionary

Parameters:

dataDef - Data definition to add.

Throws:

NullPointerException - The given data definition is null.

InvalidParameterException - A data definition with the same identifier is already contained in this dictionary.

See Also:

DataDefinitionConstant, AAFFactory.dataDefinitionForName(String), DataDefinition.forName(String), DataDefinition.forIdentification(AUID)

registerInterpolationDefinition

public void registerInterpolationDefinition(InterpolationDefinition interpolationDefinition)
                                     throws NullPointerException,
                                            InvalidParameterException

Description copied from interface: Dictionary

Add an interpolation definition to those contained in this dictionary.

Specified by:

registerInterpolationDefinition in interface Dictionary

Parameters:

interpolationDefinition - Interpolation definition to add.

Throws:

NullPointerException - The given interpolation definition is null.

InvalidParameterException - An interpolation definition with the same identifier is already contained in this dictionary.

See Also:

InterpolationConstant, InterpolationDefinition.forName(String), InterpolationDefinition.forIdentification(AUID)

registerKLVDataDefinition

public void registerKLVDataDefinition(KLVDataDefinition klvDataDefinition)
                               throws NullPointerException,
                                      InvalidParameterException

Description copied from interface: Dictionary

Add a KLV data definition to those contained in the dictionary.

Specified by:

registerKLVDataDefinition in interface Dictionary

Parameters:

klvDataDefinition - KLV data definition to add to the dictionary.

Throws:

NullPointerException - The given KLV data definition is null.

InvalidParameterException - The given KLV data definition has the same identifier as one already contained in the dictionary.

registerKLVDataKey

public void registerKLVDataKey(AUID uid,
                               TypeDefinition typeDef)
                        throws NullPointerException,
                               InvalidParameterException

Description copied from interface: Dictionary

Add the definition for the given KLV key to the runtime dictionary. The typeDef parameters will often be TypeID_UInt8Array but may be something else.

Specified by:

registerKLVDataKey in interface Dictionary

Parameters:

uid - Key to define.

typeDef - Type definition object for the key.

Throws:

NullPointerException - Argument is null.

InvalidParameterException - The specified KLV key has already been registered.

registerOpaqueTypeDefinition

public void registerOpaqueTypeDefinition(TypeDefinition typeDef)
                                  throws NullPointerException,
                                         InvalidParameterException

Description copied from interface: Dictionary

Add the opaque type definition to the dictionary.

An opaque type definition defines a property type that has a value whose type is specified in each instance.

Specified by:

registerOpaqueTypeDefinition in interface Dictionary

Parameters:

typeDef - Type definition object.

Throws:

NullPointerException - Argument is null.

InvalidParameterException - The given type has already been registered.

registerOperationDefinition

public void registerOperationDefinition(OperationDefinition operationDefinition)
                                 throws NullPointerException,
                                        InvalidParameterException

Description copied from interface: Dictionary

Add a operation definition to those contained in the dictionary.

Specified by:

registerOperationDefinition in interface Dictionary

Parameters:

operationDefinition - Operation definition to add.

Throws:

NullPointerException - The given operation definition is null.

InvalidParameterException - An operation definition with the same identifier is already contained in this dictionary.

See Also:

OperationConstant, OperationDefinition.forName(String), OperationDefinition.forIdentification(AUID)

registerParameterDefinition

public void registerParameterDefinition(ParameterDefinition parameterDefinition)
                                 throws NullPointerException,
                                        InvalidParameterException

Description copied from interface: Dictionary

Add a parameter definition to those contained in the dictionary.

Specified by:

registerParameterDefinition in interface Dictionary

Parameters:

parameterDefinition - Parameter definition to add.

Throws:

NullPointerException - The given parameter definition is null.

InvalidParameterException - A parameter definition with the same identifier is already contained in this dictionary.

See Also:

ParameterConstant, ParameterDefinition.forName(String), ParameterDefinition.forIdentification(AUID)

registerPluginDefinition

public void registerPluginDefinition(PluginDefinition pluginDefinition)
                              throws NullPointerException,
                                     InvalidParameterException

Description copied from interface: Dictionary

Add a plugin definition to those contained in this dictionary.

Specified by:

registerPluginDefinition in interface Dictionary

Parameters:

pluginDefinition - Plugin definition to add.

Throws:

NullPointerException - The given plugin definition is null.

InvalidParameterException - A plugin definition with the same identifier is already contained in this dictionary.

registerTaggedValueDefinition

public void registerTaggedValueDefinition(TaggedValueDefinition def)
                                   throws NullPointerException,
                                          InvalidParameterException

Description copied from interface: Dictionary

Add the tagged value definition to those contained in this dictionary.

Specified by:

registerTaggedValueDefinition in interface Dictionary

Parameters:

def - Tagged value definition to add to the dictionary.

Throws:

NullPointerException - The given tagged value definition is null.

InvalidParameterException - The given tagged value definition has the same identifier as one already contained in the dictionary.

registerTypeDefinition

public void registerTypeDefinition(TypeDefinition typeDef)
                            throws NullPointerException,
                                   InvalidParameterException

Description copied from interface: Dictionary

Add a type definition to those contained in this dictionary.

Specified by:

registerTypeDefinition in interface Dictionary

Parameters:

typeDef - Type definition to add to this dictionary.

Throws:

NullPointerException - The given type definition is null.

InvalidParameterException - The given type has an id that matches the id of a type definition already contained in the dictionary.

See Also:

AAFFactory.typeDefinitionForName(String), AAFFactory.typeDefinitionForIdentification(AUID), TypeDefinitionWarehouse

getId

public long getId()

setId

public void setId(long id)

clone

public Dictionary clone()

Description copied from interface: MAJCommon

Creates a cloned copy of this entity. The clone will be initialized to have the same value as this value but exists independently from then on. Changes to this value will not effect the clone and changes to the clone will not effect this. MAJ API clones are true deep clones with no shared references to areas of memory within the original.

This method does not throw a CloneNotSupportedException as all entity values must implement the Cloneable interface. If a cloning error does occur, a null value will be returned but this is very unlikely to happen.

Specified by:

clone in interface MAJCommon

Overrides:

clone in class Object

Returns:

Independent clone of this value, which is a deep copy.

See Also:

Object.clone()

appendXMLChildren

public void appendXMLChildren(Node parent)

Description copied from interface: XMLSerializable

Append child elements to the given parent node to serialize the value of an object to an XML fragment. Methods of the XMLBuilder class are provided to help with this process.

Specified by:

appendXMLChildren in interface XMLSerializable

Overrides:

appendXMLChildren in class InterchangeObject

Parameters:

parent - XML parent element to append child nodes to.