public interface MetaDefinition extends MetadataObject, WeakReferenceTarget
Specifies the definition of a class, type, or property in an AAF file.
| Modifier and Type | Method and Description |
|---|---|
void |
appendMetadictXML(Node metadict,
String namesapce,
String prefix)
Append an XML representation of this meta definition to the given XML node.
|
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 |
getDescription()
Returns the description of this meta definition.
|
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.
|
int |
hashCode()
Calculates a hash code value for this meta definition, which is calculated
from its identity.
|
void |
setAAFNamesInUse(boolean aafNames)
Set whether AAF-style names are in use for this meta definition.
|
void |
setDescription(String description)
Sets the description of this meta definition.
|
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.
|
getWeakTargetReferenceAUID getAUID()
Returns the identification for this meta definition.
getAUID in interface WeakReferenceTargetvoid setName(@AAFString String name) throws NullPointerException
Sets the name of this meta definition.
name - Name to set for this meta definition.NullPointerException - The given meta definition name is null.getAAFNamesInUse(),
setAAFNamesInUse(boolean)@AAFString String getName()
Returns the name of this meta definition.
getAAFNamesInUse(),
setAAFNamesInUse(boolean)void setDescription(@AAFString String description)
Sets the description of this meta definition. Set this optional property to
null to omit it.
description - Description of this meta definition.@AAFString String getDescription() throws PropertyNotPresentException
Returns the description of this meta definition. This is an optional property.
PropertyNotPresentException - The optional description property is not
present in this meta definition.String getNamespace()
Returns the namespace in which the subject of this meta definition is defined.
MediaProperty.namespace(),
MediaClass.namespace(),
ExtensionScheme.getSchemeURI()void setNamespace(String namespace)
Sets the namespace in which the subject of this meta definition is defined.
namespace - Namespace in which the subject of this meta definition is defined.MediaProperty.namespace(),
MediaClass.namespace()String[] getAliases()
Returns alternative names for the subject of this meta definition. These names are alternative names to the defined name for the definition.
MediaProperty.aliases(),
MediaClass.aliases()String getPrefix()
Returns the namespace prefix to use when serializing a value of the subject of this meta definition to XML.
MediaProperty.prefix(),
MediaClass.prefix()void setPrefix(String prefix)
Sets the namespace prefix to use when serializing a value of the subject of this meta definition to XML.
MediaProperty.prefix(),
MediaClass.prefix()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.
MediaProperty.symbol(),
MediaClass.symbol(),
Utilities.makeSymbol(String)void setSymbol(String symbol) throws NullPointerException
Sets the symbol used when serializing a value of the subject of this meta definition, such as its XML element or attribute name.
NullPointerException - Cannot set the symbol of a meta definition
to null.MediaProperty.symbol(),
MediaClass.symbol()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. 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
setName(String) always match.
setAAFNamesInUse(boolean),
getName(),
setName(String)void setAAFNamesInUse(boolean aafNames)
Set 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 getName() and
setName(String) always match.
aafNames - Set whether AAF-style names are in use.getAAFNamesInUse(),
getName(),
setName(String)boolean equals(Object o)
Determines 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 class Objecto - Object to check equality against.deepEquals(Object),
Object.equals(Object)boolean deepEquals(Object o)
Determines whether this definition is equal to the given object by comparing each
property. The 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.
o - Object to compare to this meta definition.equals(Object)int hashCode()
Calculates a hash code value for this meta definition, which is calculated from its identity.
hashCode in class ObjectObject.hashCode()String toString()
Creates 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 class ObjectObject.toString(),
Object.toString()void appendMetadictXML(Node metadict, String namesapce, String prefix)
Append an XML representation of this meta definition to the given XML node.
metadict - Meta dictionary node to append a description of this node to.CommonConstants.AAF_METADICT_NAMESPACEMetaDefinition clone()
Create a cloned copy of this meta definition.
(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.