|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object tv.amwa.maj.entity.InterchangeObject tv.amwa.maj.entity.DefinitionObject tv.amwa.maj.entity.TaggedValueDefinition
@AAFClass(uuid1=218169601, uuid2=257, uuid3=19456, uuid4={6,14,43,52,2,6,1,1}, definedName="TaggedValueDefinition", description="The TaggedValueDefinition class documents the TaggedValue objects used in the file.") public class TaggedValueDefinition
Implements the documentation of tagged values used in a file. The name of the definition is the same as the name of the tagged value it documents. The description of the definition provides the documentation.
THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.
Nested Class Summary | |
---|---|
static class |
TaggedValueDefinition.XMLHandler
|
Nested classes/interfaces inherited from class tv.amwa.maj.entity.DefinitionObject |
---|
DefinitionObject.DefinitionObjectXMLHandler |
Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject |
---|
InterchangeObject.InterchangeObjectXMLHandler |
Constructor Summary | |
---|---|
TaggedValueDefinition(AUID identification,
String name)
Creates and initialize all the fields of a tagged value definition, which documents the tagged value objects used in the file. |
Method Summary | |
---|---|
void |
addParentProperty(PropertyDefinition parentProperty)
Add a parent property to the list of parent properties of this tagged value definition, which specify which properties specify tagged values of this kind. |
void |
appendXMLChildren(Node parent)
Append child elements to the given parent node to serialize the value of an object to an XML fragment. |
TaggedValueDefinition |
clone()
Creates a cloned copy of this entity. |
int |
countParentProperties()
Returns the number of parent properties of this tagged value definition, which specify which properties specify tagged values of this kind. |
Set<PropertyDefinition> |
getParentProperties()
Returns the set of parent property definitions of this tagged value definition, which specify which properties specify tagged values of this kind. |
void |
removeParentProperty(PropertyDefinition parentProperty)
Removes the given parent property from the list of parent properties of this tagged value definition, which specify which properties specify tagged values of this type. |
void |
setPropertiesFromInterface(TaggedValueDefinition castFrom)
|
Methods inherited from class tv.amwa.maj.entity.DefinitionObject |
---|
equals, getAUID, getDescription, getLocalizedUID, getName, hashCode, setDescription, setLocalizedUID, setName |
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 |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface tv.amwa.maj.iface.DefinitionObject |
---|
getAUID, getDescription, getName, setDescription, setName |
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 |
Constructor Detail |
---|
public TaggedValueDefinition(AUID identification, @AAFString String name) throws NullPointerException
Creates and initialize all the fields of a tagged value definition, which documents
the tagged value
objects used in the file.
identification
- Unique identifier for the new tagged value definition object.name
- Display name of the new tagged value definition object.
NullPointerException
- One or both of the arguments is/are null
.Method Detail |
---|
public final void setPropertiesFromInterface(TaggedValueDefinition castFrom)
InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)
public void addParentProperty(PropertyDefinition parentProperty) throws NullPointerException
TaggedValueDefinition
Add a parent property to the list of parent properties of this tagged value definition, which specify which properties specify tagged values of this kind. For example, mob user comments or component attributes.
This is an extended optional property. If this property is omitted, a successful call to this method will make it present.
addParentProperty
in interface TaggedValueDefinition
parentProperty
- Parent property to add to the list of parent properties
of the tagged value definition.
NullPointerException
- The given parent property is null
.public int countParentProperties() throws PropertyNotPresentException
TaggedValueDefinition
Returns the number of parent properties of this tagged value definition, which specify which properties specify tagged values of this kind. For example, mob user comments or component attributes. This is an extended optional property.
countParentProperties
in interface TaggedValueDefinition
PropertyNotPresentException
- The optional parent properties property
is not present in this tagged value definition.public Set<PropertyDefinition> getParentProperties() throws PropertyNotPresentException
TaggedValueDefinition
Returns the set of parent property definitions of this tagged value definition, which specify which properties specify tagged values of this kind. For example, mob user comments or component attributes. This is an extended optional property.
getParentProperties
in interface TaggedValueDefinition
PropertyNotPresentException
- The optional parent properties property
is not present in this tagged value definition.public void removeParentProperty(PropertyDefinition parentProperty) throws NullPointerException, NoMoreObjectsException, PropertyNotPresentException
TaggedValueDefinition
Removes the given parent property from the list of parent properties of this tagged value definition, which specify which properties specify tagged values of this type. For example, mob user comments or component attributes. This is an extended optional property. Removing the last parent property from the set will omit the property.
removeParentProperty
in interface TaggedValueDefinition
parentProperty
- Property definition to remove from the list of parent
properties of this tagged value definition.
NullPointerException
- The given parent property to remove is not present
in the set of parent properties of this tagged value definition.
NoMoreObjectsException
- The property definition is not in the set
of parent property definitions of this tagged value definition.
PropertyNotPresentException
- The optional parent properties property
is not present in this tagged value definition.public TaggedValueDefinition clone()
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.
clone
in interface MAJCommon
clone
in class DefinitionObject
Object.clone()
public void appendXMLChildren(Node parent)
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.
appendXMLChildren
in interface XMLSerializable
appendXMLChildren
in class DefinitionObject
parent
- XML parent element to append child nodes to.
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |