public interface Dictionary extends InterchangeObject
Specifies a container for definitions. Every AAF file has a dictionary within its preface and contains a representation of the meta dictionary.
| Modifier and Type | Method and Description |
|---|---|
boolean |
addDefinition(DefinitionObject definition)
Add the given definition to this dictionary
if it is not already contained.
|
boolean |
addDefinitions(MetadataObject metadataObject)
Scan the given metadata object to see if it contains and references to
definitions not known in this dictionary,
adding any missing definitions to this dictionary as it goes.
|
Dictionary |
clone()
Create a cloned copy of 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 |
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.
|
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 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.
|
DataDefinition |
lookupAuxiliaryDataDefinition()
Returns the auxiliary data definition.
|
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.
|
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.
|
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 |
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.
|
addApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexvoid registerDataDefinition(DataDefinition dataDefinition) throws NullPointerException, InvalidParameterException
Add a data definition to the those contained in this dictionary.
dataDefinition - Data definition to add.NullPointerException - The given data definition is null.InvalidParameterException - A data definition with the
same identifier is already contained in this dictionary.DataDefinitionConstant,
Warehouse.lookup(Class, String)DataDefinition lookupDataDefinition(AUID dataDefinitionId) throws NullPointerException, InvalidParameterException
Return the data definition with the given identifier that is contained in this dictionary.
dataDefinitionId - Unique identifier for a data definition contained in this dictionary.NullPointerException - The given identifier is null.InvalidParameterException - A data definition with the given id could not
be found in this dictionary.TypeDefinitions.DataDefinitionWeakReferenceSet<? extends DataDefinition> getDataDefinitions() throws PropertyNotPresentException
Returns the set of data definitions contained in this dictionary. This is an optional property.
PropertyNotPresentException - No data definitions are present in this
dictionary.TypeDefinitions.DataDefinitionStrongReferenceSet@UInt32 int countDataDefinitions()
Returns the number of data definitions contained in this dictionary.
void registerOperationDefinition(OperationDefinition operationDefinition) throws NullPointerException, InvalidParameterException
Add a operation definition to those contained in the dictionary.
operationDefinition - Operation definition to add.NullPointerException - The given operation definition is null.InvalidParameterException - An operation definition with the
same identifier is already contained in this dictionary.OperationConstantOperationDefinition lookupOperationDefinition(AUID operationId) throws NullPointerException, InvalidParameterException
Return the operation definition with the given identifier that is contained in this dictionary.
operationId - Identifier of an operation definition contained in this dictionary.NullPointerException - The given identifier is null.InvalidParameterException - The given identifier does not match that of an operation
definition contained in this dictionary.TypeDefinitions.OperationDefinitionWeakReferenceSet<? extends OperationDefinition> getOperationDefinitions() throws PropertyNotPresentException
Returns the set of operation definitions contained in this dictionary. This is an optional property.
PropertyNotPresentException - No operation definitions are present in this
dictionary.TypeDefinitions.OperationDefinitionStrongReferenceSet@UInt32 int countOperationDefinitions()
Returns the number of operation definitions contained in this dictionary.
void registerParameterDefinition(ParameterDefinition parameterDefinition) throws NullPointerException, InvalidParameterException
Add a parameter definition to those contained in the dictionary.
parameterDefinition - Parameter definition to add.NullPointerException - The given parameter definition is null.InvalidParameterException - A parameter definition with the
same identifier is already contained in this dictionary.ParameterConstantParameterDefinition lookupParameterDefinition(AUID parameterId) throws NullPointerException, InvalidParameterException
Returns the parameter definition with the given identifier that is contained in this dictionary.
parameterId - Identifier for a parameter definition contained in this dictionary.NullPointerException - The given identifier is null.InvalidParameterException - The given identifier does not match a
parameter definition contained in this dictionary.TypeDefinitions.ParameterDefinitionWeakReferenceSet<? extends ParameterDefinition> getParameterDefinitions() throws PropertyNotPresentException
Returns the set of parameter definitions contained in this dictionary. This is an optional property.
PropertyNotPresentException - No parameter definitions are present in
this dictionary.TypeDefinitions.ParameterDefinitionStrongReferenceSet@UInt32 int countParameterDefinitions()
Returns the number of parameter definitions contained in this dictionary.
void registerCodecDefinition(CodecDefinition codecDefinition) throws NullPointerException, InvalidParameterException
Add a codec definition to those contained in this dictionary.
codecDefinition - Codec definition to add.NullPointerException - The given codec definition is null.InvalidParameterException - A codec definition with
the same identifier is already contained in this dictionary.CodecConstantCodecDefinition lookupCodecDefinition(AUID codecId) throws NullPointerException, InvalidParameterException
Returns the codec definition with the given identifier that is contained in this dictionary.
codecId - Identifier for a codec definition contained in this dictionary.NullPointerException - The given identifier is null.InvalidParameterException - The given identifier does not match a
codec definition contained in this dictionary.TypeDefinitions.CodecDefinitionWeakReferenceSet<? extends CodecDefinition> getCodecDefinitions() throws PropertyNotPresentException
Returns a set of all the codec definitions contained in the dictionary.
PropertyNotPresentException - No codec definitions are present in this
dictionary.TypeDefinitions.CodecDefinitionStrongReferenceSet@UInt32 int countCodecDefinitions()
Returns the number of codec definitions contained in this dictionary.
void registerContainerDefinition(ContainerDefinition containerDefinition) throws NullPointerException, InvalidParameterException
Add a container definition to those contained in this dictionary.
containerDefinition - Container definition to add.NullPointerException - The given container definition is null.InvalidParameterException - A container definition with
the same identifier is already contained in this dictionary.ContainerConstantContainerDefinition lookupContainerDefinition(AUID containerId) throws NullPointerException, InvalidParameterException
Returns the container definition with the given identifier that is contained in this dictionary.
containerId - Identifier for a container definition contained in this dictionary.NullPointerException - The given identifier is null.InvalidParameterException - The given identifier does not match a
codec definition contained in this dictionary.TypeDefinitions.ContainerDefinitionWeakReferenceSet<? extends ContainerDefinition> getContainerDefinitions() throws PropertyNotPresentException
Returns the set of all container definitions contained in this dictionary. This is an optional property.
PropertyNotPresentException - No container definitions are present in
this dictionary.TypeDefinitions.ContainerDefinitionStrongReferenceSet@UInt32 int countContainerDefinitions()
Returns the number of container definitions contained in this dictionary.
void registerInterpolationDefinition(InterpolationDefinition interpolationDefinition) throws NullPointerException, InvalidParameterException
Add an interpolation definition to those contained in this dictionary.
interpolationDefinition - Interpolation definition to add.NullPointerException - The given interpolation definition is null.InvalidParameterException - An interpolation definition with
the same identifier is already contained in this dictionary.InterpolationConstantInterpolationDefinition lookupInterpoliationDefinition(AUID interpolationId) throws NullPointerException, InvalidParameterException
Returns the interpolation definition with the given identifier that is contained in this dictionary.
interpolationId - Identifier for an interpolation definition contained in this dictionary.NullPointerException - The given identifier is null.InvalidParameterException - The given identifier does not match
that of an interpolation definition contained in this dictionary.TypeDefinitions.InterpolationDefinitionWeakReferenceSet<? extends InterpolationDefinition> getInterpolationDefinitions() throws PropertyNotPresentException
Returns the set of interpolation definitions contained in this dictionary. This is an optional property.
PropertyNotPresentException - No interpolation definitions are present in this
dictionary.TypeDefinitions.InterpolationDefinitionStrongReferenceSet@UInt32 int countInterpolationDefinitions()
Returns the number of interpolation definitions contained in this dictionary.
void registerPluginDefinition(PluginDefinition pluginDefinition) throws NullPointerException, InvalidParameterException
Add a plugin definition to those contained in this dictionary.
pluginDefinition - Plugin definition to add.NullPointerException - The given plugin definition is null.InvalidParameterException - A plugin definition with
the same identifier is already contained in this dictionary.PluginDefinition lookupPluginDefinition(AUID pluginId) throws NullPointerException, InvalidParameterException
Return the plugin definition with the given identifier that is contained in this dictionary.
pluginId - Identifier for a plugin definition contained in this dictionary.NullPointerException - The given identifier is null.InvalidParameterException - The given identifier does not match that of
a plugin definition contained in this dictionary.TypeDefinitions.PluginDefinitionWeakReferenceSet<? extends PluginDefinition> getPluginDefinitions() throws PropertyNotPresentException
Returns the set of plugin definitions contained in this dictionary. This is an optional property.
PropertyNotPresentException - No plugin definitions are present in this
dictionary.TypeDefinitions.PluginDefinitionStrongReferenceSet@UInt32 int countPluginDefinitions()
Returns the number of plugin definitions contained in this dictionary.
void registerKLVDataDefinition(KLVDataDefinition klvDataDefinition) throws NullPointerException, InvalidParameterException
Add a KLV data definition to those contained in the dictionary.
klvDataDefinition - KLV data definition to add to the dictionary.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.KLVDataDefinition lookupKLVDataDefinition(AUID klvDataDefinitionId) throws NullPointerException, InvalidParameterException
Returns the KLV data definition with the given identifier that is contained in this dictionary
klvDataDefinitionId - Identifier for a KLV data definition contained in this dictionary.NullPointerException - The given KLV data definition is null.InvalidParameterException - The given id does not match that of a KLV data definition
in the dictionary.Set<? extends KLVDataDefinition> getKLVDataDefinitions() throws PropertyNotPresentException
Returns the set of KLV data definitions contained in this dictionary. This is an optional property.
PropertyNotPresentException - No KLV data definitions are present in this
dictionary.TypeDefinitions.KLVDataDefinitionStrongReferenceSet@UInt32 int countKLVDataDefinitions()
Returns the number of KLV data definitions contained in this dictionary.
void registerTaggedValueDefinition(TaggedValueDefinition taggedValueDefinition) throws NullPointerException, InvalidParameterException
Add the tagged value definition to those contained in this dictionary.
taggedValueDefinition - Tagged value definition to add to the dictionary.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.TaggedValueDefinition lookupTaggedValueDefinition(AUID taggedValueDefinitionId) throws NullPointerException, InvalidParameterException
Returns the tagged value definition with the given identifier that is contained in this dictionary.
taggedValueDefinitionId - ID of the tagged value definition to lookup in the
dictionary.NullPointerException - The given identifier is null.InvalidParameterException - The given identifier does not match that of
a tagged value definition contained in this dictionary.Set<? extends TaggedValueDefinition> getTaggedValueDefinitions() throws PropertyNotPresentException
Returns a set of all tagged value definitions contained in this dictionary. This is an optional property.
PropertyNotPresentException - No tagged value definitions are present in
this dictionary.@UInt32 int countTaggedValueDefinitions()
DataDefinition lookupAuxiliaryDataDefinition()
Returns the auxiliary data definition. This is a built-in data definition for auxiliary data.
DataDefinitionConstant.AuxiliaryDataDefinition lookupDescriptiveMedadataDataDefinition()
Returns the descriptive metadata data definition. This is a built-in data definition for descriptive metadata.
DataDefinitionConstant.DescriptiveMetadataDataDefinition lookupEdgecodeDataDefinition()
Returns the edgecode data definition. This is a built-in data definition for a stream of film edge code values.
DataDefinitionConstant.Edgecode@Deprecated DataDefinition lookupLegacyPictureDataDefinition()
lookupPictureDataDefinition(), instead.Returns the legacy picture data definition. This is a built-in data definition for a stream of essence that contains image data.
DataDefinitionConstant.LegacyPicture@Deprecated DataDefinition lookupLegacySoundDataDefinition()
lookupSoundDataDefinition(), instead.Returns the legacy sound data definition. This is a built-in data definition essence that contains a single channel of sound.
DataDefinitionConstant.LegacySound@Deprecated DataDefinition lookupLegacyTimecodeDataDefinition()
lookupTimecodeDataDefinition(), instead.Returns the legacy timecode data definition. This is a built-in data definition for a stream of tape timecode values.
DataDefinitionConstant.LegacyTimecodeDataDefinition lookupMatteDataDefinition()
Returns the matte data definition. This is a built-in data definition for a stream of essence that contains alpha values.
DataDefinitionConstant.MatteDataDefinition lookupPictureDataDefinition()
Returns the picture data definition. This is a built-in data definition for a stream of essence that contains image data.
DataDefinitionConstant.PictureDataDefinition 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.
DataDefinitionConstant.PictureWithMatteDataDefinition 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.
DataDefinitionConstant.SoundDataDefinition lookupTimecodeDataDefinition()
Returns the timecode data definition. This is a built-in
data definition for a stream of tape
timecode values.
DataDefinitionConstant.Timecodeboolean addDefinitions(MetadataObject metadataObject)
Scan the given metadata object to see if it contains and references to definitions not known in this dictionary, adding any missing definitions to this dictionary as it goes.
metadataObject - Metadata object to check for missing definitions.boolean addDefinition(DefinitionObject definition)
Add the given definition to this dictionary if it is not already contained. If the definition is already represented, this methods returns successfully.
definition - Definition to add to this dictionary.Dictionary clone()
Create a cloned copy of this dictionary.
clone in interface InterchangeObjectclone in interface MediaEntity(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.