@MediaClass(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 SourcePackage or of the media associated with a physical SourcePackage.", symbol="EssenceDescriptor", isConcrete=false) public class EssenceDescriptorImpl extends InterchangeObjectImpl implements EssenceDescriptor, Serializable, Cloneable
Implements the description of the format of the content data associated with a file source package or of the media associated with a physical source package.
ObjectClassPropertyID| Constructor and Description |
|---|
EssenceDescriptorImpl() |
| Modifier and Type | Method and Description |
|---|---|
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 |
clearLocators()
Clear all the locators attached to this essence descriptor, omitting this
optional property.
|
void |
clearSubDescriptors() |
EssenceDescriptor |
clone()
Create a cloned copy of this interchange object.
|
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.
|
String |
getComment() |
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.
|
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.
|
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@MediaListAppend(value="Locators") public void appendLocator(Locator locator) throws NullPointerException
EssenceDescriptorAppend 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. Use this function to add a locator to be scanned last when searching for the essence, providing a secondary location for the essence.
appendLocator in interface EssenceDescriptorlocator - Locator to append to the list of locators in this essence descriptor.NullPointerException - The given locator is null.@MediaPropertyCount(value="Locators") public int countLocators()
EssenceDescriptorReturn 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. The number of locators may be zero if the essence is located within the current file.
countLocators in interface EssenceDescriptor@MediaListGetAt(value="Locators") public Locator getLocatorAt(int index) throws IndexOutOfBoundsException
EssenceDescriptorRetrieves 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.
getLocatorAt in interface EssenceDescriptorindex - Index of locator to retrieve from the list of locators of the essence descriptor.IndexOutOfBoundsException - The given index is outside the acceptable range for the
current list of essence descriptors.@MediaProperty(uuid1=100729092, uuid2=1539, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Locators", aliases={"Locator","EssenceDescriptorLocator","EssenceDescriptorLocators"}, typeName="LocatorStrongReferenceVector", optional=true, uniqueIdentifier=false, pid=12033, symbol="Locators") public List<Locator> getLocators() throws PropertyNotPresentException
EssenceDescriptorReturns 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. This is an optional property and is omitted when the essence is in the current file.
getLocators in interface EssenceDescriptorPropertyNotPresentException - No locators are present for this essence descriptor.TypeDefinitions.LocatorStrongReferenceVector@MediaListInsertAt(value="Locators") public void insertLocatorAt(int index, Locator locator) throws NullPointerException, IndexOutOfBoundsException
EssenceDescriptorInserts a locator into the list of locators of this essence descriptors at the given index. Each locator has operating-system-dependent data or text information that provide hints for finding files or physical media. The locators already existing at the given and higher indices will be moved to the next higher index to accommodate.
insertLocatorAt in interface EssenceDescriptorindex - Index at which locator is to be insertedlocator - Locator to insert.NullPointerException - Argument is null.IndexOutOfBoundsException - The given index is outside the acceptable range for the
current list of essence descriptors.@MediaListPrepend(value="Locators") public void prependLocator(Locator locator) throws NullPointerException
EssenceDescriptorPrepend 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. Use this function to add a locator to be scanned first when searching for the essence, providing a new primary location for the essence.
prependLocator in interface EssenceDescriptorlocator - Locator to prepend to the list of locators in this essence descriptor.NullPointerException@MediaListRemoveAt(value="Locators") public void removeLocatorAt(int index) throws IndexOutOfBoundsException
EssenceDescriptorRemoves 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. Locators already existing at indices higher than the given index will be moved to the next lower index to accommodate.
removeLocatorAt in interface EssenceDescriptorindex - Index of locator to remove from the list of locators of this essence descriptor.IndexOutOfBoundsException - The given index is outside the acceptable range for the
current list of essence descriptors.@MediaPropertyClear(value="Locators") public void clearLocators()
EssenceDescriptorClear all the locators attached to this essence descriptor, omitting this optional property.
clearLocators in interface EssenceDescriptor@MediaProperty(uuid1=100729092, uuid2=1552, uuid3=0, uuid4={6,14,43,52,1,1,1,9}, definedName="SubDescriptors", typeName="SubDescriptorStrongReferenceVector", optional=true, uniqueIdentifier=false, pid=12034, symbol="SubDescriptors") public List<SubDescriptor> getSubDescriptors() throws PropertyNotPresentException
EssenceDescriptorReturns 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. This is an optional property.
getSubDescriptors in interface EssenceDescriptorPropertyNotPresentException - No sub descriptors are present for this essence
descriptor.TypeDefinitions.SubDescriptorStrongReferenceVector@MediaPropertyCount(value="SubDescriptors") public int countSubDescriptors()
EssenceDescriptorReturns 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. This list of sub-descriptors may be empty.
countSubDescriptors in interface EssenceDescriptor@MediaListAppend(value="SubDescriptors") public void appendSubDescriptor(SubDescriptor subDescriptor) throws NullPointerException
EssenceDescriptorAppend 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.
appendSubDescriptor in interface EssenceDescriptorsubDescriptor - Sub descriptor to append to the list of sub descriptors for this essence descriptor.NullPointerException - The given sub descriptor is null.@MediaListGetAt(value="SubDescriptors") public SubDescriptor getSubDescriptorAt(@UInt32 int index) throws IndexOutOfBoundsException
EssenceDescriptorReturns 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.
getSubDescriptorAt in interface EssenceDescriptorindex - Index of the sub descriptor value to retrieve.IndexOutOfBoundsException - The given index is outside the acceptable range
for the current list of sub descriptors.@MediaListPrepend(value="SubDescriptors") public void prependSubDescriptor(SubDescriptor subDescriptor)
EssenceDescriptorPrepend 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.
prependSubDescriptor in interface EssenceDescriptorsubDescriptor - Sub descriptor to prepend to the list of sub descriptors for this essence descriptor.@MediaListInsertAt(value="SubDescriptors") public void insertSubDescriptorAt(@UInt32 int index, SubDescriptor subDescriptor) throws NullPointerException, IndexOutOfBoundsException
EssenceDescriptorInserts the given sub descriptor into the list of sub descriptors of this essence descriptor at the given index. Sub descriptors specify additional descriptor metadata that is not included in the main essence descriptor class hierarchy.
insertSubDescriptorAt in interface EssenceDescriptorindex - Index at which the sub descriptor should be inserted into the list of sub
descriptors of this essence descriptor.subDescriptor - Sub descriptor to insert.NullPointerException - The sub descriptor argument is null.IndexOutOfBoundsException - The given index is outside the acceptable range
for the list of sub descriptors of this essence descriptor.@MediaListRemoveAt(value="SubDescriptors") public void removeSubDescriptorAt(@UInt32 int index) throws IndexOutOfBoundsException
EssenceDescriptorRemoves 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. Sub descriptors at higher indices will be moved to fill the gap made by the removal.
removeSubDescriptorAt in interface EssenceDescriptorindex - Index of the sub descriptor to remove.IndexOutOfBoundsException - The given index is outside the acceptable range
for the current list of sub descriptors.@MediaPropertyClear(value="SubDescriptors") public void clearSubDescriptors()
public EssenceDescriptor clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface EssenceDescriptorclone in interface InterchangeObjectclone in class InterchangeObjectImplpublic String getComment()
getComment in class InterchangeObjectImpl(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.