EssenceDescriptor (MAJ API)

Overview

Package

Class

Tree

Deprecated

Index

Media Authoring
with Java API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

tv.amwa.maj.entity
Class EssenceDescriptor

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

All Implemented Interfaces:: Serializable, Cloneable, EssenceDescriptor, InterchangeObject, XMLSerializable

Direct Known Subclasses:: AAFFileDescriptor, FilmDescriptor, PhysicalDescriptor, TapeDescriptor

@AAFClass(uuid1=218169601, uuid2=257, uuid3=9216, uuid4={6,14,43,52,2,6,1,1}, definedName="EssenceDescriptor", description="The EssenceDescriptor class describes the format of the essence associated with a file SourceMob or of the media associated with a physical SourceMob.") public abstract class EssenceDescriptor
extends InterchangeObject
implements EssenceDescriptor, Serializable, Cloneable
extends InterchangeObject
implements EssenceDescriptor, Serializable, Cloneable

Implements the description of the format of the content data associated with a file source mob or of the media associated with a physical source mob.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:: Richard Cartwright
See Also:: Serialized Form

Nested Class Summary
`static class`	`EssenceDescriptor.EssenceDescriptorXMLHandler`
`static class`	`EssenceDescriptor.LocatorXMLHandler`
`static class`	`EssenceDescriptor.SubDescriptorXMLHandler`

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

Field Summary
`static String`	`ESSENCEDESCRIPTOR_ITEM`

Constructor Summary
`EssenceDescriptor()`

Method Summary
`void`	`appendLocator(Locator locator)` Append a locator to the list of locators of this essence descriptors, with each locator having operating-system-dependent data or text information that provide hints for finding files or physical media.
`void`	`appendSubDescriptor(SubDescriptor subDescriptor)` Append a sub descriptor to the list of sub descriptors of this essence descriptor, which specify additional descriptor metadata that is not included in the main essence descriptor class hierarchy.
`void`	`appendXMLChildren(Node parent)` Append child elements to the given parent node to serialize the value of an object to an XML fragment.
`EssenceDescriptor`	`clone()`
`int`	`countLocators()` Return the number of locators attached to this essence descriptor, which each have operating-system-dependent data or text information that provide hints for finding files or physical media.
`int`	`countSubDescriptors()` Returns the number of sub descriptors attached to this essence descriptor, which specify additional descriptor metadata that is not included in the main essence descriptor class hierarchy.
`boolean`	`equals(Object o)`
`Locator`	`getLocatorAt(int index)` Retrieves the locator at the given index, where each locator has operating-system-dependent data or text information that provide hints for finding files or physical media.
`List<Locator>`	`getLocators()` Returns a list of all the locators in this essence descriptors, where each locator has operating-system-dependent data or text information that provide hints for finding files or physical media.
`SubDescriptor`	`getSubDescriptorAt(int index)` Returns the sub descriptor at the given index through the list of sub descriptors of this essence descriptor, which specify additional descriptor metadata that is not included in the main essence descriptor class hierarchy.
`List<SubDescriptor>`	`getSubDescriptors()` Returns the list of sub descriptors of this essence descriptor, which specify additional descriptor metadata that is not included in the main essence descriptor class hierarchy.
`int`	`hashCode()`
`void`	`insertLocatorAt(int index, Locator locator)` Inserts a locator into the list of locators of this essence descriptors at the given index.
`void`	`insertSubDescriptorAt(int index, SubDescriptor subDescriptor)` Inserts the given sub descriptor into the list of sub descriptors of this essence descriptor at the given index.
`void`	`prependLocator(Locator locator)` Prepend a locator to the list of locators of this essence descriptor, with each locator having operating-system-dependent data or text information that provide hints for finding files or physical media.
`void`	`prependSubDescriptor(SubDescriptor subDescriptor)` Prepend a sub descriptor to the list of sub descriptors of this essence descriptor, which specify additional descriptor metadata that is not included in the main essence descriptor class hierarchy.
`void`	`removeLocatorAt(int index)` Removes the locator at the given index, where each locator has operating-system-dependent data or text information that provide hints for finding files or physical media.
`void`	`removeSubDescriptorAt(int index)` Removes the sub descriptor at the given index through the list of sub descriptors of this essence descriptor, which specify additional descriptor metadata that is not included in the main essence descriptor class hierarchy.
`void`	`setPropertiesFromInterface(EssenceDescriptor 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

ESSENCEDESCRIPTOR_ITEM

public static final String ESSENCEDESCRIPTOR_ITEM

See Also:: Constant Field Values

Constructor Detail

EssenceDescriptor

public EssenceDescriptor()

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(EssenceDescriptor castFrom)

See Also:: InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)