@MediaClass(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.", symbol="Component", isConcrete=false) public class ComponentImpl extends InterchangeObjectImpl implements Component, QComponent, Cloneable, Serializable
Implements an essence element.
ObjectClassPropertyID| Constructor and Description |
|---|
ComponentImpl() |
| Modifier and Type | Method and Description |
|---|---|
void |
appendComponentAttribute(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 |
appendComponentAttribute(TaggedValue componentAttribute)
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 |
appendComponentKLVData(KLVData klvData)
Appends a KLV Data to the collection of KLV data of
this component.
|
void |
appendComponentUserComment(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 |
appendComponentUserComment(TaggedValue userComment)
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 |
clearComponentAttributes()
Clear all attributes from this component, omitting this optional property.
|
void |
clearComponentKLVData()
Clear the list of KLV data for this component, omitting this
optional property.
|
void |
clearComponentUserComments()
Clears the list of user comments of this components, omitting this optional
property.
|
Component |
clone()
Create a cloned copy of this interchange object.
|
int |
countComponentAttributes()
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 |
countComponentKLVData()
Returns the total number of KLV data in the collection for this
component.
|
int |
countComponentUserComments()
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).
|
String |
getComment() |
List<TaggedValue> |
getComponentAttributes()
Returns the collection of attributes of this component, which specify
attributes that are under the control of the application (for example filter control).
|
DataDefinition |
getComponentDataDefinition()
Returns the data definition of the component, which specifies the kind of
data described by this component.
|
List<KLVData> |
getComponentKLVData()
Returns the list of KLV data of this component.
|
long |
getComponentLength()
Returns the length of this component, which specifies its duration in edit
units.
|
List<TaggedValue> |
getComponentUserComments()
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).
|
String |
getEditName() |
int |
getJupiterClipOffset() |
String |
getJupiterID() |
boolean |
getLengthPresent()
Determines whether the length property is present for this component.
|
static DataDefinition |
initializeComponentDataDefinition() |
void |
prependComponentAttribute(TaggedValue componentAttribute) |
void |
prependComponentKLVData(KLVData klvData) |
void |
prependComponentUserComment(TaggedValue userComment) |
void |
removeComponentAttribute(TaggedValue componentAttribute)
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 |
removeComponentKLVData(KLVData klvData)
Removes the given KLV data from the collection of this component.
|
void |
removeComponentUserComment(TaggedValue userComment)
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 |
setComponentDataDefinition(DataDefinition componentDataDefinition)
Sets the data definition property for the component, which specifies the kind of
data described by this component.
|
void |
setComponentLength(long componentLength)
Sets the length property of this component, which specifies its
duration in edit units.
|
void |
setComponentLengthFromStream(long componentLength) |
void |
setEditName(String editName) |
void |
setJupiterClipOffset(Integer jupiterClipOffset) |
void |
setJupiterID(String jupiterID) |
void |
setLengthPresent(boolean lengthPresent)
Sets whether the length property is present for this component.
|
addApplicationPlugin, appendXMLChildren, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getLinkedGenerationIDString, getObjectClass, getPersistentID, getPersistentIndex, hashCode, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setLinkedGenerationIDString, setObjectClass, setPersistentID, setPersistentIndex, toStringaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndex@MediaProperty(uuid1=50397712, uuid2=2048, uuid3=0, uuid4={6,14,43,52,1,1,1,7}, definedName="ComponentAttributes", aliases="Attributes", typeName="TaggedValueStrongReferenceVector", optional=true, uniqueIdentifier=false, pid=517, symbol="ComponentAttributes") public List<TaggedValue> getComponentAttributes() throws PropertyNotPresentException
ComponentReturns the collection of attributes of this component, which specify attributes that are under the control of the application (for example filter control). This is an optional property.
getComponentAttributes in interface ComponentPropertyNotPresentException - No attributes are present for this component.TypeDefinitions.TaggedValueStrongReferenceVectorpublic void appendComponentAttribute(String name, String value) throws NullPointerException
ComponentAppend 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.
appendComponentAttribute in interface Componentname - 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.@MediaListAppend(value="ComponentAttributes") public void appendComponentAttribute(TaggedValue componentAttribute) throws NullPointerException
ComponentAppend 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).
appendComponentAttribute in interface ComponentcomponentAttribute - Tagged value to be appended to the collection of attributes for this
component.NullPointerException - The given attribute value is null.TaggedValueDefinition@MediaPropertyRemove(value="ComponentAttributes") public void removeComponentAttribute(TaggedValue componentAttribute) throws NullPointerException, PropertyNotPresentException, ObjectNotFoundException
ComponentRemove 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).
removeComponentAttribute in interface ComponentcomponentAttribute - Attribute to remove from the collection of attributes of
the component.NullPointerException - The given attribute is null.PropertyNotPresentException - No attributes are present for this component.ObjectNotFoundException - The given tagged value is not currently
contained by the list of attributes of this component.@MediaPropertyCount(value="ComponentAttributes") public int countComponentAttributes()
ComponentReturns 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).
countComponentAttributes in interface Component@MediaListPrepend(value="ComponentAttributes") public void prependComponentAttribute(TaggedValue componentAttribute) throws NullPointerException
NullPointerException@MediaPropertyClear(value="ComponentAttributes") public void clearComponentAttributes()
ComponentClear all attributes from this component, omitting this optional property.
clearComponentAttributes in interface Component@MediaProperty(uuid1=50462978, uuid2=5632, uuid3=0, uuid4={6,14,43,52,1,1,1,7}, definedName="ComponentUserComments", aliases="UserComments", typeName="TaggedValueStrongReferenceVector", optional=true, uniqueIdentifier=false, pid=516, symbol="ComponentUserComments") public List<TaggedValue> getComponentUserComments() throws PropertyNotPresentException
ComponentReturns 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 is an optional property.
getComponentUserComments in interface ComponentPropertyNotPresentException - No user comments are present for this component.TypeDefinitions.TaggedValueStrongReferenceVectorpublic void appendComponentUserComment(String name, String value) throws NullPointerException
ComponentAppend 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.
appendComponentUserComment in interface Componentname - 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.@MediaListAppend(value="ComponentUserComments") public void appendComponentUserComment(TaggedValue userComment)
ComponentAppend 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).
appendComponentUserComment in interface ComponentuserComment - User comment to append to the collection of user comments of this component.TaggedValueDefinition@MediaPropertyCount(value="ComponentUserComments") public int countComponentUserComments()
ComponentReturns 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).
countComponentUserComments in interface Component@MediaPropertyRemove(value="ComponentUserComments") public void removeComponentUserComment(TaggedValue userComment) throws NullPointerException, PropertyNotPresentException, ObjectNotFoundException
ComponentRemoves 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).
removeComponentUserComment in interface ComponentuserComment - User comment to remove from the collection of user comments of
this component.NullPointerException - The given comment is null.PropertyNotPresentException - No user comments are present for this component.ObjectNotFoundException - The comment to be removed cannot be
found in the collection of comments of this component.@MediaPropertyClear(value="ComponentUserComments") public void clearComponentUserComments()
ComponentClears the list of user comments of this components, omitting this optional property.
clearComponentUserComments in interface Component@MediaListPrepend(value="ComponentUserComments") public void prependComponentUserComment(TaggedValue userComment) throws NullPointerException
NullPointerException@MediaProperty(uuid1=67567872, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ComponentDataDefinition", aliases="DataDefinition", typeName="DataDefinitionWeakReference", optional=false, uniqueIdentifier=false, pid=513, symbol="ComponentDataDefinition") public DataDefinition getComponentDataDefinition()
ComponentReturns the data definition of the component, which specifies the kind of data described by this component.
getComponentDataDefinition in interface ComponentTypeDefinitions.DataDefinitionWeakReference@MediaPropertySetter(value="ComponentDataDefinition") public void setComponentDataDefinition(DataDefinition componentDataDefinition) throws NullPointerException
ComponentSets the data definition property for the component, which specifies the kind of data described by this component.
setComponentDataDefinition in interface ComponentcomponentDataDefinition - Data definition of this component.NullPointerException - The given data definition is null.public static final DataDefinition initializeComponentDataDefinition()
@MediaProperty(uuid1=50397712, uuid2=1024, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ComponentKLVData", aliases="KLVData", typeName="KLVDataStrongReferenceVector", optional=true, uniqueIdentifier=false, pid=515, symbol="ComponentKLVData") public List<KLVData> getComponentKLVData() throws PropertyNotPresentException
ComponentReturns the list of KLV data of this component. This is an optional property.
getComponentKLVData in interface ComponentPropertyNotPresentException - No KLV data items are present for this component.TypeDefinitions.KLVDataStrongReferenceVector@MediaListAppend(value="ComponentKLVData") public void appendComponentKLVData(KLVData klvData) throws NullPointerException
ComponentAppends a KLV Data to the collection of KLV data of this component.
appendComponentKLVData in interface ComponentklvData - KLV data value to add to the set of KLV data values of
this component.NullPointerException - The given KLV data value is null.@MediaPropertyCount(value="ComponentKLVData") public int countComponentKLVData()
ComponentReturns the total number of KLV data in the collection for this component.
countComponentKLVData in interface Component@MediaPropertyRemove(value="ComponentKLVData") public void removeComponentKLVData(KLVData klvData) throws NullPointerException, PropertyNotPresentException, ObjectNotFoundException
ComponentRemoves the given KLV data from the collection of this component.
removeComponentKLVData in interface ComponentklvData - KLV data value to remove from the component.NullPointerException - The given KLV data item is null.PropertyNotPresentException - No KLV data items are present for this component.ObjectNotFoundException - The given KLV data object is not in the collection of
this component.@MediaListPrepend(value="ComponentKLVData") public void prependComponentKLVData(KLVData klvData) throws NullPointerException
NullPointerException@MediaPropertyClear(value="ComponentKLVData") public void clearComponentKLVData()
ComponentClear the list of KLV data for this component, omitting this optional property.
clearComponentKLVData in interface Component@MediaProperty(uuid1=117572097, uuid2=259, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ComponentLength", aliases="Length", typeName="LengthType", optional=true, uniqueIdentifier=false, pid=514, symbol="ComponentLength") public long getComponentLength() throws BadPropertyException
ComponentReturns 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.
getComponentLength in interface ComponentBadPropertyException - The optional length property is not present
for this object.public void setComponentLength(long componentLength)
throws BadLengthException
ComponentSets 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.
setComponentLength in interface ComponentcomponentLength - The duration in edit units of this component.BadLengthException - Cannot set the length to a negative value.@MediaPropertySetter(value="ComponentLength") public void setComponentLengthFromStream(long componentLength) throws BadLengthException
BadLengthExceptionpublic boolean getLengthPresent()
ComponentDetermines whether the length property is present for this component. This method allows
a user to prepare a component for a specific kind of track
according the the length rules of tracks. These rules are:
timeline track
then it shall have a length property.static trackt then
it shall not have a length property.event track then
it may have a length property. In this case, if no length property is specified then the component
describes an instantaneous 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.
getLengthPresent in interface Componentpublic void setLengthPresent(boolean lengthPresent)
ComponentSets whether the length property is present for this component. This method allows
a user to prepare a component for a specific kind of track
according the the length rules of tracks. These rules are:
timeline track
then it shall have a length property.static track then
it shall not have a length property.event track then
it may have a length property. In this case, if no length property is specified then the component
describes an instantaneous 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 track and
static track 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.
setLengthPresent in interface ComponentlengthPresent - Is the context-dependent length property present for this component?@MediaProperty(uuid1=1172384523, uuid2=-21475, uuid3=17326, uuid4={-99,-76,54,-16,101,-81,-61,-21}, definedName="Jupiter ID", symbol="Jupiter_ID", aliases="Jupiter_ID", typeName="UTF16String", optional=true, uniqueIdentifier=false, pid=0, prefix="q", namespace="http://www.quantel.com/genQ/extensions") public String getJupiterID() throws PropertyNotPresentException
getJupiterID in interface QComponentPropertyNotPresentException@MediaPropertySetter(value="Jupiter ID") public void setJupiterID(String jupiterID)
setJupiterID in interface QComponent@MediaProperty(uuid1=-1709905003, uuid2=-19950, uuid3=19729, uuid4={-68,93,-78,-13,107,55,-70,43}, definedName="Jupiter Clip Offset", symbol="Jupiter_Clip_Offset", aliases="Jupiter_Clip_Offset", typeName="Int32", optional=true, uniqueIdentifier=false, pid=0, prefix="q", namespace="http://www.quantel.com/genQ/extensions") @Int32 public int getJupiterClipOffset() throws PropertyNotPresentException
getJupiterClipOffset in interface QComponentPropertyNotPresentException@MediaPropertySetter(value="Jupiter Clip Offset") public void setJupiterClipOffset(@Int32 Integer jupiterClipOffset)
setJupiterClipOffset in interface QComponent@MediaProperty(uuid1=-19088744, uuid2=8807, uuid3=4563, uuid4={-118,76,0,80,4,14,-9,-46}, definedName="EditName", symbol="EditName", aliases="EditName", typeName="UTF16String", optional=true, uniqueIdentifier=false, pid=0, prefix="q", namespace="http://www.quantel.com/genQ/extensions") public String getEditName() throws PropertyNotPresentException
getEditName in interface QComponentPropertyNotPresentException@MediaPropertySetter(value="EditName") public void setEditName(String editName)
setEditName in interface QComponentpublic String getComment()
getComment in class InterchangeObjectImplpublic Component clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface Componentclone in interface InterchangeObjectclone in class InterchangeObjectImpl(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.