|
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.Component
@AAFClass(uuid1=218169601, uuid2=257, uuid3=512, uuid4={6,14,43,52,2,6,1,1}, definedName="Component", description="The Component class represents an essence element.") public abstract class Component
Implements an essence element.
THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.
Nested Class Summary | |
---|---|
static class |
Component.ComponentAttributesXMLHandler
|
static class |
Component.ComponentUserCommentsXMLHandler
|
static class |
Component.ComponentXMLHandler
|
static class |
Component.KLVDataXMLHandler
|
Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject |
---|
InterchangeObject.InterchangeObjectXMLHandler |
Field Summary | |
---|---|
static String |
COMPONENT_ITEM
|
Constructor Summary | |
---|---|
Component()
|
Method Summary | |
---|---|
void |
appendAttribute(String name,
String value)
Append an attribute name/value pair to the attributes collection of of this component, which specify attributes that are under the control of the application (for example filter control). |
void |
appendAttribute(TaggedValue taggedValue)
Append an attribute defined by an existing tagged value to the attributes collection of this component, which specify attributes that are under the control of the application (for example filter control). |
void |
appendComment(String name,
String value)
Append a user comment name/value pair to the collection of user comments of the component, which specify user comments that are directly classified and set up by the operator (for example Bin columns). |
void |
appendComment(TaggedValue comment)
Append a user comment defined by an existing tagged value to the collection of user comments of this component, which specify user comments that are directly classified and set up by the operator (for example Bin columns). |
void |
appendKLVData(KLVData data)
Appends a KLV Data to the collection of KLV data of this component. |
void |
appendXMLChildren(Node parent)
Append child elements to the given parent node to serialize the value of an object to an XML fragment. |
int |
countAttributes()
Returns the size of the collection of attributes for the component, which specify attributes that are under the control of the application (for example filter control). |
int |
countComments()
Returns the number of user comments in the collection of user comments of this component, which specify user comments that are directly classified and set up by the operator (for example Bin columns). |
int |
countKLVData()
Returns the total number of KLV data in the collection for this component. |
boolean |
equals(Object o)
|
List<TaggedValue> |
getAttributes()
Returns the collection of attributes of this component, which specify attributes that are under the control of the application (for example filter control). |
List<TaggedValue> |
getComments()
Returns the collection of user comments of the component, which specify user comments that are directly classified and set up by the operator (for example Bin columns). |
DataDefinition |
getDataDefinition()
Returns the data definition of the component, which specifies the kind of data described by this component. |
List<KLVData> |
getKLVData()
Returns the list of KLV data of this component. |
long |
getLength()
Returns the length of this component, which specifies its duration in edit units. |
boolean |
getLengthPresent()
Determines whether the length property is present for this component. |
int |
hashCode()
|
void |
removeAttribute(TaggedValue attribute)
Remove an attribute from the collection of attributes of this component, which specify attributes that are under the control of the application (for example filter control). |
void |
removeComment(TaggedValue comment)
Removes a given user comment from the collection of user comments of this component, which specify user comments that are directly classified and set up by the operator (for example Bin columns). |
void |
removeKLVData(KLVData data)
Removes the given KLV data from the collection of this component. |
void |
setDataDefinition(DataDefinition dataDefinition)
Sets the data definition property for the component, which specifies the kind of data described by this component. |
void |
setLength(long length)
Sets the length property of this component, which specifies its duration in edit units. |
void |
setLengthPresent(boolean lengthPresent)
Sets whether the length property is present for this component. |
void |
setPropertiesFromInterface(Component castFrom)
|
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, wait, wait, wait |
Methods inherited from interface tv.amwa.maj.iface.InterchangeObject |
---|
countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue |
Field Detail |
---|
public static final String COMPONENT_ITEM
Constructor Detail |
---|
public Component()
Method Detail |
---|
public final void setPropertiesFromInterface(Component castFrom)
@AAFProperty(uuid1=50397712, uuid2=2048, uuid3=0, uuid4={6,14,43,52,1,1,1,7}, definedName="Attributes", typeName="StrongReferenceVector of TaggedValue", optional=true, uniqueIdentifier=false, pid=517) public List<TaggedValue> getAttributes()
Component
Returns the collection of attributes of this component, which specify attributes that are under the control of the application (for example filter control).
getAttributes
in interface Component
public void appendAttribute(String name, String value) throws NullPointerException
Component
Append an attribute name/value pair to the attributes collection of of this component, which specify attributes that are under the control of the application (for example filter control).
This method creates a new tagged value, initializes it with the specified attribute name/value pair, and appends it to the attribute list.
appendAttribute
in interface Component
name
- Name for the new attribute.value
- Corresponding value for the new attribute.
NullPointerException
- One or both of the given name and/or value method
parameters are null
.public void appendAttribute(TaggedValue taggedValue) throws NullPointerException
Component
Append an attribute defined by an existing tagged value to the attributes collection of this component, which specify attributes that are under the control of the application (for example filter control).
appendAttribute
in interface Component
taggedValue
- Tagged value to be appended to the collection of attributes for this
component.
NullPointerException
- The given attribute value is null
.makeTaggedValue()
,
TaggedValueDefinition
public void removeAttribute(TaggedValue attribute) throws NullPointerException, ObjectNotFoundException
Component
Remove an attribute from the collection of attributes of this component, which specify attributes that are under the control of the application (for example filter control).
removeAttribute
in interface Component
attribute
- Attribute to remove from the collection of attributes of
the component.
NullPointerException
- The given attribute is null
.
ObjectNotFoundException
- The given tagged value is not currently
contained by the list of attributes of this component.public int countAttributes()
Component
Returns the size of the collection of attributes for the component, which specify attributes that are under the control of the application (for example filter control).
countAttributes
in interface Component
@AAFProperty(uuid1=50462978, uuid2=5632, uuid3=0, uuid4={6,14,43,52,1,1,1,7}, definedName="UserComments", typeName="StrongReferenceVector of TaggedValue", optional=true, uniqueIdentifier=false, pid=516) public List<TaggedValue> getComments()
Component
Returns the collection of user comments of the component, which specify user comments that are directly classified and set up by the operator (for example Bin columns).
getComments
in interface Component
public void appendComment(String name, String value) throws NullPointerException
Component
Append a user comment name/value pair to the collection of user comments of the component, which specify user comments that are directly classified and set up by the operator (for example Bin columns).
This method creates a new tagged value, initializes it with the specified comment name/value pair, and appends it to the comment list.
appendComment
in interface Component
name
- The name associated with the new comment to create.value
- The corresponding value, or description, of the new comment.
NullPointerException
- One or both of the name and/or value values is/are null
.makeTaggedValue()
public void appendComment(TaggedValue comment)
Component
Append a user comment defined by an existing tagged value to the collection of user comments of this component, which specify user comments that are directly classified and set up by the operator (for example Bin columns).
appendComment
in interface Component
comment
- User comment to append to the collection of user comments of this component.makeTaggedValue()
,
TaggedValueDefinition
public int countComments()
Component
Returns the number of user comments in the collection of user comments of this component, which specify user comments that are directly classified and set up by the operator (for example Bin columns).
countComments
in interface Component
public void removeComment(TaggedValue comment) throws NullPointerException, ObjectNotFoundException
Component
Removes a given user comment from the collection of user comments of this component, which specify user comments that are directly classified and set up by the operator (for example Bin columns).
removeComment
in interface Component
comment
- User comment to remove from the collection of user comments of
this component.
NullPointerException
- The given comment is null
.
ObjectNotFoundException
- The comment to be removed cannot be
found in the collection of comments of this component.@AAFProperty(uuid1=67567872, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="DataDefinition", typeName="WeakReference to DataDefinition", optional=false, uniqueIdentifier=false, pid=513) public DataDefinition getDataDefinition()
Component
Returns the data definition of the component, which specifies the kind of data described by this component.
getDataDefinition
in interface Component
public void setDataDefinition(DataDefinition dataDefinition) throws NullPointerException
Component
Sets the data definition property for the component, which specifies the kind of data described by this component.
setDataDefinition
in interface Component
dataDefinition
- Data definition of this component.
NullPointerException
- The given data definition is null
.@AAFProperty(uuid1=50397712, uuid2=1024, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="KLVData", typeName="StrongReferenceVector of KLVData", optional=true, uniqueIdentifier=false, pid=515) public List<KLVData> getKLVData()
Component
Returns the list of KLV data of this component.
getKLVData
in interface Component
public void appendKLVData(KLVData data) throws NullPointerException
Component
Appends a KLV Data to the collection of KLV data of this component.
appendKLVData
in interface Component
data
- KLV data value to add to the set of KLV data values of
this component.
NullPointerException
- The given KLV data value is null
.makeKLVData()
public int countKLVData()
Component
Returns the total number of KLV data in the collection for this component.
countKLVData
in interface Component
public void removeKLVData(KLVData data) throws NullPointerException, ObjectNotFoundException
Component
Removes the given KLV data from the collection of this component.
removeKLVData
in interface Component
data
- KLV data value to remove from the component.
NullPointerException
- The given KLV data item is null
.
ObjectNotFoundException
- The given KLV data object is not in the collection of
this component.@AAFProperty(uuid1=117572097, uuid2=259, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Length", typeName="LengthType", optional=true, uniqueIdentifier=false, pid=514) public long getLength() throws BadPropertyException
Component
Returns the length of this component, which specifies its duration in edit units. This is an optional property, which will be present for time-varying media and may be present for events.
getLength
in interface Component
BadPropertyException
- The optional length property is not present
for this object.public void setLength(long length) throws BadLengthException
Component
Sets the length property of this component, which specifies its duration in edit units. This is an optional property, which will only be present for time-varying media.
setLength
in interface Component
length
- The duration in edit units of this component.
BadLengthException
- Cannot set the length to a negative value.public boolean getLengthPresent()
Determines whether the length property is present for this component. This method allows
a user to prepare a component for a specific kind of mob slot
according the the length rules of mob slots. These rules are:
timeline mob slot
then it shall have a length property.static mob slot
then
it shall not have a length property.event mob slot
then
it may have a length property. In this case, if no length property is specified then the component
describes an instantaneious event
that does not have
a duration.The default value is that length values are not present, although components that are not
appropriate for static data overried this to be true
.
public void setLengthPresent(boolean lengthPresent)
Sets whether the length property is present for this component. This method allows
a user to prepare a component for a specific kind of mob slot
according the the length rules of mob slots. These rules are:
timeline mob slot
then it shall have a length property.static mob slot
then
it shall not have a length property.event mob slot
then
it may have a length property. In this case, if no length property is specified then the component
describes an instantaneious event
that does not have
a duration.The default value is that length values are not present, although components that are not
appropriate for static data override this to be true
. The constructors and
setSegment()
methods of timeline mob slot
and
static mob slot
will set the presence or absence
of the length property according to the above rules. Therefore, this method is mainly useful to set
whether an event
should be considered as instantaneous
or not.
lengthPresent
- Is the context-dependent length property present for this component?public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
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 InterchangeObject
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 |