@MediaClass(uuid1=218169601, uuid2=548, uuid3=0, uuid4={6,14,43,52,2,6,1,1}, definedName="MetaDefinition", description="The MetaDefinition class is an abstract class that defines a class, type, or property in an AAF file.", symbol="MetaDefinition", namespace="http://www.smpte-ra.org/schemas/2001-2/2007/aaf", prefix="aaf") public abstract class MetaDefinitionImpl extends Object implements MetaDefinition, DefinitionType, WeakReferenceTarget, Serializable, CommonConstants, Cloneable
Implements the definition of a class, type, or property in an AAF file.
Extension of the meta model with external classes is not encouraged. The metamodel can be used to describe extensions in the main AAF object model. Therefore, the registration of classes is restricted to this package only.
AAF_METADICT_NAMESPACE, AAF_METADICT_PREFIX, AAF_XML_NAMESPACE, AAF_XML_PREFIX, ApplicationPluginObjectID, ApplicationPluginsID, MAX_NUM_RGBA_COMPS, MemberOfID, ObjectClassID, ParentClassID, PropertiesID, XMLClassIDAsAttributeName| Constructor and Description |
|---|
MetaDefinitionImpl() |
| Modifier and Type | Method and Description |
|---|---|
String |
aafNameToName(String name) |
void |
appendMetadictXML(Node metadict,
String namespace,
String prefix)
Append an XML representation of this meta definition to the given XML node.
|
void |
appendXMLChildren(Node parent) |
MetaDefinition |
clone()
Create a cloned copy of this meta definition.
|
boolean |
deepEquals(Object o)
Determines whether this definition is equal to the given object by comparing each
property.
|
boolean |
equals(Object o)
Determines whether this meta definition is equal to the given meta
definition by comparing identifiers.
|
boolean |
getAAFNamesInUse()
Are AAF-style names are in use for this meta definition? The default is
false that
is to use pass through names that match those defined in the meta dictionary. |
String[] |
getAliases()
Returns alternative names for the subject of this meta definition.
|
AUID |
getAUID()
Returns the identification for this meta definition.
|
String |
getComment() |
String |
getDescription()
Returns the description of this meta definition.
|
AUID |
getIdentification() |
String |
getName()
Returns the name of this meta definition.
|
String |
getNamespace()
Returns the namespace in which the subject of this meta definition is defined.
|
String |
getPrefix()
Returns the namespace prefix to use when serializing a value of the subject of this meta
definition to XML.
|
String |
getSymbol()
Returns the symbol used when serializing a value of the subject of this meta
definition, such as its XML element or attribute name.
|
String |
getWeakTargetReference()
Provides a name that can be used to make a weak object reference to an
instance of the implementing class.
|
int |
hashCode()
Calculates a hash code value for this meta definition, which is calculated
from its identity.
|
static AUID |
initializeMetaDefinitionIdentification() |
static String |
initializeMetaDefinitionName() |
String |
nameToAAFName(String name) |
void |
setAAFNamesInUse(boolean aafNamesInUse)
Set whether AAF-style names are in use for this meta definition.
|
void |
setAliases(String[] aliases) |
void |
setDescription(String description)
Sets the description of this meta definition.
|
void |
setIdentification(AUID identification) |
void |
setName(String name)
Sets the name of this meta definition.
|
void |
setNamespace(String namespace)
Sets the namespace in which the subject of this meta definition is defined.
|
void |
setPrefix(String prefix)
Sets the namespace prefix to use when serializing a value of the subject of this meta
definition to XML.
|
void |
setSymbol(String symbol)
Sets the symbol used when serializing a value of the subject of this meta
definition, such as its XML element or attribute name.
|
String |
toString()
Creates a string representation of this meta definition.
|
@MediaProperty(uuid1=100729095, uuid2=4864, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="MetaDefinitionIdentification", aliases={"Identification","AUID"}, typeName="AUID", optional=false, uniqueIdentifier=true, pid=5, symbol="MetaDefinitionIdentification") public final AUID getAUID()
MetaDefinitionReturns the identification for this meta definition.
getAUID in interface WeakReferenceTargetgetAUID in interface MetaDefinitiongetAUID in interface DefinitionTypepublic AUID getIdentification()
public static final AUID initializeMetaDefinitionIdentification()
@MediaPropertySetter(value="MetaDefinitionIdentification") public final void setIdentification(AUID identification) throws NullPointerException
NullPointerException@MediaProperty(uuid1=100729095, uuid2=5121, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="MetaDefinitionDescription", aliases="Description", typeName="UTF16String", optional=true, uniqueIdentifier=false, pid=7, symbol="MetaDefinitionDescription") public final String getDescription() throws PropertyNotPresentException
MetaDefinitionReturns the description of this meta definition. This is an optional property.
getDescription in interface MetaDefinitiongetDescription in interface DefinitionTypePropertyNotPresentException - The optional description property is not
present in this meta definition.@MediaPropertySetter(value="MetaDefinitionDescription") public final void setDescription(String description)
MetaDefinitionSets the description of this meta definition. Set this optional property to
null to omit it.
setDescription in interface MetaDefinitiondescription - Description of this meta definition.@MediaProperty(uuid1=50463745, uuid2=513, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="MetaDefinitionName", aliases="Name", typeName="UTF16String", optional=false, uniqueIdentifier=false, pid=6, symbol="MetaDefinitionName") public final String getName()
MetaDefinitionReturns the name of this meta definition.
getName in interface MetaDefinitiongetName in interface DefinitionTypeMetaDefinition.getAAFNamesInUse(),
MetaDefinition.setAAFNamesInUse(boolean)@MediaPropertySetter(value="MetaDefinitionName") public final void setName(String name) throws NullPointerException
MetaDefinitionSets the name of this meta definition.
setName in interface MetaDefinitionname - Name to set for this meta definition.NullPointerException - The given meta definition name is null.MetaDefinition.getAAFNamesInUse(),
MetaDefinition.setAAFNamesInUse(boolean)public static final String initializeMetaDefinitionName()
public final boolean equals(Object o)
MetaDefinitionDetermines whether this meta definition is equal to the given meta
definition by comparing identifiers. Identities are only compared if the
given object is not null and implements this interface.
equals in interface MetaDefinitionequals in class Objecto - Object to check equality against.MetaDefinition.deepEquals(Object),
Object.equals(Object)public boolean deepEquals(Object o)
MetaDefinitionDetermines whether this definition is equal to the given object by comparing each
property. The MetaDefinition.equals(Object) method only checks that the identities of two
definitions are equal, relying on the uniqueness ensured by identity registration.
This method is provided for debugging and validation purposes.
deepEquals in interface MetaDefinitiono - Object to compare to this meta definition.MetaDefinition.equals(Object)public final int hashCode()
MetaDefinitionCalculates a hash code value for this meta definition, which is calculated from its identity.
hashCode in interface MetaDefinitionhashCode in class ObjectObject.hashCode()public String toString()
MetaDefinitionCreates a string representation of this meta definition. In the MAJ API, the string representation is an XML representation that should validate against SMPTE Reg-XML (SMPTE 2001).
toString in interface MetaDefinitiontoString in class ObjectObject.toString(),
Object.toString()public void appendXMLChildren(Node parent)
public String getComment()
public String getSymbol()
MetaDefinitionReturns the symbol used when serializing a value of the subject of this meta definition, such as its XML element or attribute name.
getSymbol in interface MetaDefinitionMediaProperty.symbol(),
MediaClass.symbol(),
Utilities.makeSymbol(String)public void setSymbol(String symbol) throws NullPointerException
MetaDefinitionSets the symbol used when serializing a value of the subject of this meta definition, such as its XML element or attribute name.
setSymbol in interface MetaDefinitionNullPointerException - Cannot set the symbol of a meta definition
to null.MediaProperty.symbol(),
MediaClass.symbol()public String getWeakTargetReference()
WeakReferenceTargetProvides a name that can be used to make a weak object reference to an instance of the implementing class.
getWeakTargetReference in interface WeakReferenceTargetpublic String getNamespace()
MetaDefinitionReturns the namespace in which the subject of this meta definition is defined.
getNamespace in interface MetaDefinitionMediaProperty.namespace(),
MediaClass.namespace(),
ExtensionScheme.getSchemeURI()public void setNamespace(String namespace)
MetaDefinitionSets the namespace in which the subject of this meta definition is defined.
setNamespace in interface MetaDefinitionnamespace - Namespace in which the subject of this meta definition is defined.MediaProperty.namespace(),
MediaClass.namespace()public String getPrefix()
MetaDefinitionReturns the namespace prefix to use when serializing a value of the subject of this meta definition to XML.
getPrefix in interface MetaDefinitionMediaProperty.prefix(),
MediaClass.prefix()public void setPrefix(String prefix)
MetaDefinitionSets the namespace prefix to use when serializing a value of the subject of this meta definition to XML.
setPrefix in interface MetaDefinitionMediaProperty.prefix(),
MediaClass.prefix()public void setAliases(String[] aliases)
public String[] getAliases()
MetaDefinitionReturns alternative names for the subject of this meta definition. These names are alternative names to the defined name for the definition.
getAliases in interface MetaDefinitionMediaProperty.aliases(),
MediaClass.aliases()public boolean getAAFNamesInUse()
MetaDefinitionAre AAF-style names are in use for this meta definition? The default is false that
is to use pass through names that match those defined in the meta dictionary. AAF names
have slightly different values, for example:
aafInt32 instead of Int32;kAAFTypeID_LocatorStrongReference instead of LocatorStrongReference.These names are useful when writing meta dictionaries into AAF files. The internal mappings inside
the class deal with mapping to and from the different names so that @link #getName()} and
MetaDefinition.setName(String) always match.
getAAFNamesInUse in interface MetaDefinitionMetaDefinition.setAAFNamesInUse(boolean),
MetaDefinition.getName(),
MetaDefinition.setName(String)public void setAAFNamesInUse(boolean aafNamesInUse)
MetaDefinitionSet whether AAF-style names are in use for this meta definition. The default is false that
is to use pass through names that match those defined in the meta dictionary. AAF names
have slightly different values, for example:
aafInt32 instead of Int32;kAAFTypeID_LocatorStrongReference instead of LocatorStrongReference.These names are useful when writing meta dictionaries into AAF files. The internal mappings inside
the class deal with mapping to and from the different names so that MetaDefinition.getName() and
MetaDefinition.setName(String) always match.
setAAFNamesInUse in interface MetaDefinitionaafNamesInUse - Set whether AAF-style names are in use.MetaDefinition.getAAFNamesInUse(),
MetaDefinition.getName(),
MetaDefinition.setName(String)public void appendMetadictXML(Node metadict, String namespace, String prefix)
MetaDefinitionAppend an XML representation of this meta definition to the given XML node.
appendMetadictXML in interface MetaDefinitionmetadict - Meta dictionary node to append a description of this node to.CommonConstants.AAF_METADICT_NAMESPACEpublic MetaDefinition clone()
MetaDefinitionCreate a cloned copy of this meta definition.
clone in interface MetaDefinitionclone in class Object(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.