tv.amwa.maj.entity
Class DataEssenceDescriptor

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.EssenceDescriptor
          tv.amwa.maj.entity.AAFFileDescriptor
              tv.amwa.maj.entity.DataEssenceDescriptor

All Implemented Interfaces:

Serializable, Cloneable, MAJCommon, AAFFileDescriptor, DataEssenceDescriptor, EssenceDescriptor, InterchangeObject, XMLSerializable

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=17152,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="DataEssenceDescriptor",
          description="Specifies that a file source mob is associated with data essence.")
public class DataEssenceDescriptor
extends AAFFileDescriptor
implements DataEssenceDescriptor, Serializable, Cloneable, MAJCommon

Implements the description of a file of data essence and identifies the data coding of that essence. Data essence includes that specified in MXF mappings for MPEG (SMPTE 381M), DV (SMPTE 383M), D10 and D11 (SMPTE 386M). Data essence often refers to time-varying data, such as subtitles (closed captions).

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class

DataEssenceDescriptor.XMLHandler

Nested classes/interfaces inherited from class tv.amwa.maj.entity.AAFFileDescriptor

AAFFileDescriptor.FileDescriptorXMLHandler

Nested classes/interfaces inherited from class tv.amwa.maj.entity.EssenceDescriptor

EssenceDescriptor.EssenceDescriptorXMLHandler, EssenceDescriptor.LocatorXMLHandler, EssenceDescriptor.SubDescriptorXMLHandler

Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject

InterchangeObject.InterchangeObjectXMLHandler

Field Summary

static String

DATAESSENCEDESCRIPTOR_TAG

Fields inherited from class tv.amwa.maj.entity.AAFFileDescriptor

FILEDESCRIPTOR_ITEM

Fields inherited from class tv.amwa.maj.entity.EssenceDescriptor

ESSENCEDESCRIPTOR_ITEM

Constructor Summary

DataEssenceDescriptor(ContainerDefinition containerFormat)
Creates and initializes a new data essence descriptor, which specifies that a file source mob is associated with data essence.

Method Summary

void	appendXMLChildren(Node parent) Append child elements to the given parent node to serialize the value of an object to an XML fragment.
DataEssenceDescriptor	clone() Creates a cloned copy of this entity.
boolean	equals(Object o) Tests to see if the given object is equal to this interchange object.
AUID	getDataEssenceCoding() Returns the data essence coding property of this data essence descriptor.
int	hashCode() Returns a hash code value for this interchange object.
void	setDataEssenceCoding(AUID dataEssenceCoding) Sets the data essence coding property of this data essence descriptor.
void	setPropertiesFromInterface(DataEssenceDescriptor castFrom)

Methods inherited from class tv.amwa.maj.entity.AAFFileDescriptor

describesStaticEssence, getCodecDefinition, getContainerFormat, getLength, getLinkedSlotID, getSampleRate, setCodecDefinition, setContainerFormat, setDescribesStaticEssence, setDescribesTimeVaryingEssence, setLength, setLinkedSlotID, setPropertiesFromInterface, setSampleRate

Methods inherited from class tv.amwa.maj.entity.EssenceDescriptor

appendLocator, appendSubDescriptor, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAt, setPropertiesFromInterface

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.AAFFileDescriptor

getCodecDefinition, getContainerFormat, getLength, getLinkedSlotID, getSampleRate, setCodecDefinition, setContainerFormat, setLength, setLinkedSlotID, setSampleRate

Methods inherited from interface tv.amwa.maj.iface.EssenceDescriptor

appendLocator, appendSubDescriptor, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAt

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

toString

Field Detail

DATAESSENCEDESCRIPTOR_TAG

public static final String DATAESSENCEDESCRIPTOR_TAG

See Also:

Constant Field Values

Constructor Detail

DataEssenceDescriptor

public DataEssenceDescriptor(ContainerDefinition containerFormat)
                      throws NullPointerException

Creates and initializes a new data essence descriptor, which specifies that a file source mob is associated with data essence.

Parameters:

containerFormat - Container format of the associated data essence.

Throws:

NullPointerException - The container format argument is null.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(DataEssenceDescriptor castFrom)

See Also:

InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)

getDataEssenceCoding

@AAFProperty(uuid1=67306242,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,3},
             definedName="DataEssenceCoding",
             typeName="AUID",
             optional=true,
             uniqueIdentifier=false,
             pid=15873)
public AUID getDataEssenceCoding()
                          throws PropertyNotPresentException

Description copied from interface: DataEssenceDescriptor

Returns the data essence coding property of this data essence descriptor.

Specified by:

getDataEssenceCoding in interface DataEssenceDescriptor

Returns:

Data essence coding property of this data essence descriptor.

Throws:

PropertyNotPresentException - The optional data essence coding property is not present in this data essence descriptor.

setDataEssenceCoding

public void setDataEssenceCoding(AUID dataEssenceCoding)

Description copied from interface: DataEssenceDescriptor

Sets the data essence coding property of this data essence descriptor. Setting this optional property to null omits the property.

Specified by:

setDataEssenceCoding in interface DataEssenceDescriptor

Parameters:

dataEssenceCoding - Data essence coding property of this data essence descriptor.

equals

public boolean equals(Object o)

Description copied from interface: MAJCommon

Tests to see if the given object is equal to this interchange object. To be equal, the given value must be not null, share the same interface to its value and each of the properties of the value must each be equal.

Specified by:

equals in interface MAJCommon

Overrides:

equals in class AAFFileDescriptor

Parameters:

o - Object to test for equality with.

Returns:

Is the given object equals to this value?

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Description copied from interface: MAJCommon

Returns a hash code value for this interchange object.

Specified by:

hashCode in interface MAJCommon

Overrides:

hashCode in class AAFFileDescriptor

Returns:

Hash code value for this interchange object.

See Also:

Object.hashCode()

clone

public DataEssenceDescriptor clone()

Description copied from interface: 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.

Specified by:

clone in interface MAJCommon

Overrides:

clone in class EssenceDescriptor

Returns:

Independent clone of this value, which is a deep copy.

See Also:

Object.clone()

appendXMLChildren

public void appendXMLChildren(Node parent)

Description copied from interface: 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.

Specified by:

appendXMLChildren in interface XMLSerializable

Overrides:

appendXMLChildren in class AAFFileDescriptor

Parameters:

parent - XML parent element to append child nodes to.