tv.amwa.maj.iface
Interface Dictionary

All Superinterfaces:

InterchangeObject

All Known Implementing Classes:

Dictionary

public interface Dictionary
extends InterchangeObject

Specifies 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.

Author:

Richard Cartwright

See Also:

makeDictionary(), DefinitionObject, MetaDefinition, Header.getDictionary()

Method Summary

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<? extends ClassDefinition>	getClassDefinitions() Returns the set of all class definitions in this dictionary.
Set<? extends CodecDefinition>	getCodecDefinitions() Returns a set of all the codec definitions contained in the dictionary.
Set<? extends ContainerDefinition>	getContainerDefinitions() Returns the set of all container definitions contained in this dictionary.
Set<? extends DataDefinition>	getDataDefinitions() Returns the set of data definitions contained in this dictionary.
Set<? extends InterpolationDefinition>	getInterpolationDefinitions() Returns the set of interpolation definitions contained in this dictionary.
Set<? extends KLVDataDefinition>	getKLVDataDefinitions() Returns the set of KLV data definitions contained in this dictionary.
Set<? extends TypeDefinition>	getOpaqueTypeDefinitions() Return the set of all registered opaque type definitions in the dictionary.
Set<? extends OperationDefinition>	getOperationDefinitions() Returns the set of operation definitions contained in this dictionary.
Set<? extends ParameterDefinition>	getParameterDefinitions() Returns the set of parameter definitions contained in this dictionary.
Set<? extends PluginDefinition>	getPluginDefinitions() Returns the set of plugin definitions contained in this dictionary.
Set<? extends TaggedValueDefinition>	getTaggedValueDefinitions() Returns a set of all tagged value definitions contained in this dictionary.
Set<? extends 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 identification) 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 klvDataDefinitionId) Returns the KLV data definition with the given identifier that is contained in this dictionary
DataDefinition	lookupLegacyPictureDataDefinition() Deprecated. As of AAF v1.1, the legacy picture data definition is deprecated. Use the picture data definition, as returned by lookupPictureDataDefinition(), instead.
DataDefinition	lookupLegacySoundDataDefinition() Deprecated. As of AAF v1.1, the legacy sound data definition is deprecated. Use the sound data definition, as returned by lookupSoundDataDefinition(), instead.
DataDefinition	lookupLegacyTimecodeDataDefinition() Deprecated. As of AAF v1.1, the legacy timecode data definition is deprecated. Use the timecode data definition, as returned by lookupTimecodeDataDefinition(), instead.
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 taggedValueDefinitionId) 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 identification) Return the type definition with the given identifier that is contained within this dictionary.
void	registerClassDefinition(ClassDefinition classDefinition) Add a class definition to those contained in this dictionary.
void	registerCodecDefinition(CodecDefinition codecDefinition) 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 dataDefinition) 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 taggedValueDefinition) Add the tagged value definition to those contained in this dictionary.
void	registerTypeDefinition(TypeDefinition typeDefinition) Add a type definition to those contained in this dictionary.

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

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

Method Detail

createInstance

InterchangeObject createInstance(AUID identification)
                                 throws NotImplementedException

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.

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

MetaDefinition createMetaInstance(AUID identification)
                                  throws NotImplementedException

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.

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

registerClassDefinition

void registerClassDefinition(ClassDefinition classDefinition)
                             throws InvalidParameterException,
                                    NullPointerException

Add a class definition to those contained in this dictionary.

Parameters:

classDefinition - 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

lookupClassDefinition

ClassDefinition lookupClassDefinition(AUID identification)
                                      throws NullPointerException,
                                             InvalidParameterException

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

Parameters:

identification - 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

getClassDefinitions

Set<? extends ClassDefinition> getClassDefinitions()

Returns the set of all class definitions in this dictionary.

Returns:

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

countClassDefinitions

@UInt32
int countClassDefinitions()

Returns the number of class definitions contained in this dictionary.

Returns:

Number of class definitions contained in this dictionary.

createForwardClassReference

void createForwardClassReference(AUID classId)
                                 throws InvalidParameterException

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.

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.

hasForwardClassReference

@Bool
boolean hasForwardClassReference(AUID classId)
                                 throws InvalidParameterException

Returns true if the given class identification is a forward reference registered with this 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.

registerTypeDefinition

void registerTypeDefinition(TypeDefinition typeDefinition)
                            throws NullPointerException,
                                   InvalidParameterException

Add a type definition to those contained in this dictionary.

Parameters:

typeDefinition - 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

lookupTypeDefinition

TypeDefinition lookupTypeDefinition(AUID identification)
                                    throws NullPointerException,
                                           InvalidParameterException

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

Parameters:

identification - 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.

getTypeDefinitions

Set<? extends TypeDefinition> getTypeDefinitions()

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

Returns:

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

countTypeDefinitions

@UInt32
int countTypeDefinitions()

Returns the number of type definitions contained in the dictionary.

Returns:

Number of type definitions in this dictionary.

registerOpaqueTypeDefinition

void registerOpaqueTypeDefinition(TypeDefinition typeDef)
                                  throws NullPointerException,
                                         InvalidParameterException

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.

Parameters:

typeDef - Type definition object.

Throws:

NullPointerException - Argument is null.

InvalidParameterException - The given type has already been registered.

lookupOpaqueTypeDefinition

TypeDefinition lookupOpaqueTypeDefinition(AUID typeId)
                                          throws NullPointerException,
                                                 InvalidParameterException

Return the opaque type definition with the given id.

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.

getOpaqueTypeDefinitions

Set<? extends TypeDefinition> getOpaqueTypeDefinitions()

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

Returns:

Iterator over the set of all registered opaque type definitions.

countOpaqueTypeDefinitions

@UInt32
int countOpaqueTypeDefinitions()

Returns the number of opaque type definitions in the dictionary.

Returns:

Number of opaque type definitions.

registerKLVDataKey

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

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.

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.

registerDataDefinition

void registerDataDefinition(DataDefinition dataDefinition)
                            throws NullPointerException,
                                   InvalidParameterException

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

Parameters:

dataDefinition - 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)

lookupDataDefinition

DataDefinition lookupDataDefinition(AUID dataDefinitionId)
                                    throws NullPointerException,
                                           InvalidParameterException

Return the data definition with the given identifier that is contained in this 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.

getDataDefinitions

Set<? extends DataDefinition> getDataDefinitions()

Returns the set of data definitions contained in this dictionary.

Returns:

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

countDataDefinitions

@UInt32
int countDataDefinitions()

Returns the number of data definitions contained in this dictionary.

Returns:

Number of data definitions contained in this dictionary.

registerOperationDefinition

void registerOperationDefinition(OperationDefinition operationDefinition)
                                 throws NullPointerException,
                                        InvalidParameterException

Add a operation definition to those contained in the 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)

lookupOperationDefinition

OperationDefinition lookupOperationDefinition(AUID operationId)
                                              throws NullPointerException,
                                                     InvalidParameterException

Return the operation definition with the given identifier that is contained in this 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.

getOperationDefinitions

Set<? extends OperationDefinition> getOperationDefinitions()

Returns the set of operation definitions contained in this dictionary.

Returns:

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

countOperationDefinitions

@UInt32
int countOperationDefinitions()

Returns the number of operation definitions contained in this dictionary.

Returns:

Number of operation definitions contained in this dictionary.

registerParameterDefinition

void registerParameterDefinition(ParameterDefinition parameterDefinition)
                                 throws NullPointerException,
                                        InvalidParameterException

Add a parameter definition to those contained in the 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)

lookupParameterDefinition

ParameterDefinition lookupParameterDefinition(AUID parameterId)
                                              throws NullPointerException,
                                                     InvalidParameterException

Returns the parameter definition with the given identifier that is contained in this 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.

getParameterDefinitions

Set<? extends ParameterDefinition> getParameterDefinitions()

Returns the set of parameter definitions contained in this dictionary.

Returns:

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

countParameterDefinitions

@UInt32
int countParameterDefinitions()

Returns the number of parameter definitions contained in this dictionary.

Returns:

Number of parameter definitions contained in this dictionary.

registerCodecDefinition

void registerCodecDefinition(CodecDefinition codecDefinition)
                             throws NullPointerException,
                                    InvalidParameterException

Add a codec definition to those contained in this dictionary.

Parameters:

codecDefinition - 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)

lookupCodecDefinition

CodecDefinition lookupCodecDefinition(AUID codecId)
                                      throws NullPointerException,
                                             InvalidParameterException

Returns the codec definition with the given identifier that is contained in this 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.

getCodecDefinitions

Set<? extends CodecDefinition> getCodecDefinitions()

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

Returns:

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

countCodecDefinitions

@UInt32
int countCodecDefinitions()

Returns the number of codec definitions contained in this dictionary.

Returns:

Number of codec definitions contained in this dictionary.

registerContainerDefinition

void registerContainerDefinition(ContainerDefinition containerDefinition)
                                 throws NullPointerException,
                                        InvalidParameterException

Add a container definition to those contained in this 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)

lookupContainerDefinition

ContainerDefinition lookupContainerDefinition(AUID containerId)
                                              throws NullPointerException,
                                                     InvalidParameterException

Returns the container definition with the given identifier that is contained in this 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.

getContainerDefinitions

Set<? extends ContainerDefinition> getContainerDefinitions()

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

Returns:

Shallow copy of the set of container definitions.

countContainerDefinitions

@UInt32
int countContainerDefinitions()

Returns the number of container definitions contained in this dictionary.

Returns:

Number of container definitions contained in this dictionary.

registerInterpolationDefinition

void registerInterpolationDefinition(InterpolationDefinition interpolationDefinition)
                                     throws NullPointerException,
                                            InvalidParameterException

Add an interpolation definition to those contained in this 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)

lookupInterpoliationDefinition

InterpolationDefinition lookupInterpoliationDefinition(AUID interpolationId)
                                                       throws NullPointerException,
                                                              InvalidParameterException

Returns the interpolation definition with the given identifier that is contained in this 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.

getInterpolationDefinitions

Set<? extends InterpolationDefinition> getInterpolationDefinitions()

Returns the set of interpolation definitions contained in this dictionary.

Returns:

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

countInterpolationDefinitions

@UInt32
int countInterpolationDefinitions()

Returns the number of interpolation definitions contained in this dictionary.

Returns:

Number of interpolation definitions contained in this dictionary.

registerPluginDefinition

void registerPluginDefinition(PluginDefinition pluginDefinition)
                              throws NullPointerException,
                                     InvalidParameterException

Add a plugin definition to those contained in this 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.

lookupPluginDefinition

PluginDefinition lookupPluginDefinition(AUID pluginId)
                                        throws NullPointerException,
                                               InvalidParameterException

Return the plugin definition with the given identifier that is contained in this 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.

getPluginDefinitions

Set<? extends PluginDefinition> getPluginDefinitions()

Returns the set of plugin definitions contained in this dictionary.

Returns:

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

countPluginDefinitions

@UInt32
int countPluginDefinitions()

Returns the number of plugin definitions contained in this dictionary.

Returns:

Number of plugin definitions contained in this dictionary.

registerKLVDataDefinition

void registerKLVDataDefinition(KLVDataDefinition klvDataDefinition)
                               throws NullPointerException,
                                      InvalidParameterException

Add a KLV data definition to those contained in the 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.

lookupKLVDataDefinition

KLVDataDefinition lookupKLVDataDefinition(AUID klvDataDefinitionId)
                                          throws NullPointerException,
                                                 InvalidParameterException

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

Parameters:

klvDataDefinitionId - 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.

getKLVDataDefinitions

Set<? extends KLVDataDefinition> getKLVDataDefinitions()

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

Returns:

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

countKLVDataDefinitions

@UInt32
int countKLVDataDefinitions()

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

Returns:

Number of KLV data definitions contained in this dictionary.

registerTaggedValueDefinition

void registerTaggedValueDefinition(TaggedValueDefinition taggedValueDefinition)
                                   throws NullPointerException,
                                          InvalidParameterException

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

Parameters:

taggedValueDefinition - 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.

lookupTaggedValueDefinition

TaggedValueDefinition lookupTaggedValueDefinition(AUID taggedValueDefinitionId)
                                                  throws NullPointerException,
                                                         InvalidParameterException

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

Parameters:

taggedValueDefinitionId - 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.

getTaggedValueDefinitions

Set<? extends TaggedValueDefinition> getTaggedValueDefinitions()

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

Returns:

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

countTaggedValueDefinitions

@UInt32
int countTaggedValueDefinitions()

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

Returns:

Number of tagged value definitions contained in the dictionary.

lookupAuxiliaryDataDefinition

DataDefinition lookupAuxiliaryDataDefinition()

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

Returns:

Auxiliary data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.Auxiliary

lookupDescriptiveMedadataDataDefinition

DataDefinition lookupDescriptiveMedadataDataDefinition()

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

Returns:

Descriptive metadata data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.DescriptiveMetadata

lookupEdgecodeDataDefinition

DataDefinition lookupEdgecodeDataDefinition()

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

Returns:

Edgecode data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.Edgecode

lookupLegacyPictureDataDefinition

@Deprecated
DataDefinition lookupLegacyPictureDataDefinition()

Deprecated. As of AAF v1.1, the legacy picture data definition is deprecated. Use the picture data definition, as returned by lookupPictureDataDefinition(), instead.

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

Returns:

Legacy picture data definition.

See Also:

DataDefinitionConstant.LegacyPicture

lookupLegacySoundDataDefinition

@Deprecated
DataDefinition lookupLegacySoundDataDefinition()

Deprecated. As of AAF v1.1, the legacy sound data definition is deprecated. Use the sound data definition, as returned by lookupSoundDataDefinition(), instead.

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

Returns:

Legacy sound data definition.

See Also:

DataDefinitionConstant.LegacySound

lookupLegacyTimecodeDataDefinition

@Deprecated
DataDefinition lookupLegacyTimecodeDataDefinition()

Deprecated. As of AAF v1.1, the legacy timecode data definition is deprecated. Use the timecode data definition, as returned by lookupTimecodeDataDefinition(), instead.

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

Returns:

Legacy timecode data definition.

See Also:

DataDefinitionConstant.LegacyTimecode

lookupMatteDataDefinition

DataDefinition lookupMatteDataDefinition()

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

Returns:

Matte data definition.

See Also:

DataDefinitionConstant.Matte

lookupPictureDataDefinition

DataDefinition lookupPictureDataDefinition()

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

Returns:

Picture data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.Picture

lookupPictureWithMatteDataDefinition

DataDefinition lookupPictureWithMatteDataDefinition()

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.

Returns:

Picture with matte data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.PictureWithMatte

lookupSoundDataDefinition

DataDefinition lookupSoundDataDefinition()

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.

Returns:

Sound data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.Sound

lookupTimecodeDataDefinition

DataDefinition lookupTimecodeDataDefinition()

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

Returns:

Timecode data definition.

See Also:

AAFFactory.dataDefinitionForName(String), DataDefinitionConstant.Timecode