Media Authoring
with Java API

tv.amwa.maj.entity
Class BWFImportDescriptor

java.lang.Object
  extended by tv.amwa.maj.entity.InterchangeObject
      extended by tv.amwa.maj.entity.EssenceDescriptor
          extended by tv.amwa.maj.entity.PhysicalDescriptor
              extended by tv.amwa.maj.entity.ImportDescriptor
                  extended by tv.amwa.maj.entity.BWFImportDescriptor
All Implemented Interfaces:
Serializable, Cloneable, MAJCommon, BWFImportDescriptor, EssenceDescriptor, ImportDescriptor, InterchangeObject, PhysicalDescriptor, XMLSerializable

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=20480,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="BWFImportDescriptor",
          description="Specifies audio essence represented according to the Broadcast Wave specifications.")
public class BWFImportDescriptor
extends ImportDescriptor
implements BWFImportDescriptor, Serializable, Cloneable, MAJCommon

Implements the description of audio essence that is formatted according the the Broadcast Wave Format specifications, which is a file essence source that is not directly manipulated by an AAF application.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:
Richard Cartwright
See Also:
Serialized Form

Nested Class Summary
static class BWFImportDescriptor.UnknownBWFChunksXMLHandler
           
static class BWFImportDescriptor.XMLHandler
           
 
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 BWFIMPORTDESCRIPTOR_TAG
           
 
Fields inherited from class tv.amwa.maj.entity.ImportDescriptor
IMPORTDESCRIPTOR_TAG
 
Fields inherited from class tv.amwa.maj.entity.EssenceDescriptor
ESSENCEDESCRIPTOR_ITEM
 
Constructor Summary
BWFImportDescriptor()
          Creates and initializes a new BWF import descriptor, which specifies audio data essence according to the Broadcast Wave specifications.
 
Method Summary
 void appendUnknownBWFChunk(RIFFChunk chunk)
          Append a RIFFChunk to end of the list of unknown BWF chunks of this BWF import descriptor.
 void appendXMLChildren(Node parent)
          Append child elements to the given parent node to serialize the value of an object to an XML fragment.
 BWFImportDescriptor clone()
          Creates a cloned copy of this entity.
 int countUnknownBWFChunks()
          Returns the total number of unknown BWF chunks attached to this BWF import descriptor.
 boolean equals(Object o)
          Tests to see if the given object is equal to this interchange object.
 String getBasicData()
          Returns the basic data of this BWF import descriptor, which is taken from the basic data property of the associated <qlty> chunk.
 String getCodingHistory()
          Returns the coding history property of this BWF import descriptor, which is taken from the coding history property of the associated <bext> chunk.
 String getCueSheet()
          Returns the cue sheet property of this BWF import descriptor, which is taken from the cue sheet data property of the associated <qlty> chunk.
 String getEndOfModulation()
          Returns the end of modulation property of this BWF import descriptor, which is taken from the end modulation data property of the associated <qlty> chunk.
 int getFileSecurityReport()
          Returns the file security code of the quality report of this BWF import descriptor.
 int getFileSecurityWave()
          Returns the file security code of the BWF wave data of this BWF import descriptor.
 String getOperatorComment()
          Returns the operator comment property of this BWF import descriptor, which is taken from the comment of operator property of the associated <qlty> chunk.
 String getQualityEvent()
          Returns the quality event data property of this BWF import descriptor, which is taken from the quality event data property of the associated <qlty> chunk.
 String getQualityParameter()
          Returns the quality parameter property of this BWF import descriptor, which is taken from the quality parameter data property of the associated <qlty> chunk.
 String getStartOfModulation()
          Returns the start of modulation data of this BWF import descriptor, which is taken from the start modulation data poperty of the associated <qlty> chunk.
 RIFFChunk getUnknownBWFChunkAt(int index)
          Returns the RIFFChunk from the list of unknown BWF chunks of this BWF import descriptor at the given index.
 List<RIFFChunk> getUnknownBWFChunks()
          Returns a copy of the list of unknown BWF chunks of this BWF import descriptor.
 int hashCode()
          Returns a hash code value for this interchange object.
 void insertUnknownBWFChunkAt(int index, RIFFChunk chunk)
          Insert a RIFFChunk into the list of unknown BWF chunks of this BWF import descriptor at the given index.
 void prependUnknownBWFChunk(RIFFChunk chunk)
          Prepend a RIFFChunk to the beginning of the list of unknown BWF chunks of this BWF descriptor.
 void removeUnknownBWFChunkAt(int index)
          Removes the RIFFChunk at the given index through the list of unknown BWF chunks of this BWF descriptor.
 void setBasicData(String basicData)
          Sets the basic data of this BWF import descriptor, which is taken from the basic data property of the associated <qlty> chunk.
 void setCodingHistory(String codingHistory)
          Sets the coding history property of this BWF import descriptor, which is taken from the coding history property of the associated <bext> chunk.
 void setCueSheet(String cueSheet)
          Sets the cue sheet property of this BWF import descriptor, which is taken from the cue sheet data property of the associated <qlty> chunk.
 void setEndOfModulation(String endOfModulation)
          Sets the end of modulation property of this BWF import descriptor, which is taken from the end modulation data property of the associated <qlty> chunk.
 void setFileSecurityReport(Integer fileSecurityReport)
          Set the file security code of the quality report of this BWF import descriptor.
 void setFileSecurityWave(Integer fileSecurityWave)
          Sets the file security code of the BWF wave data of this BWF import descriptor.
 void setOperatorComment(String operatorComment)
          Sets the operator comment property of this BWF import descriptor, which is taken from the comment of operator property of the associated <qlty> chunk.
 void setPropertiesFromInterface(BWFImportDescriptor castFrom)
           
 void setQualityEvent(String qualityEvent)
          Sets the quality event data property of this BWF import descriptor, which is taken from the quality event data property of the associated <qlty> chunk.
 void setQualityParameter(String qualityParameter)
          Sets the quality parameter property of this BWF import descriptor, which is taken from the quality parameter data property of the associated <qlty> chunk.
 void setStartOfModulation(String startOfModulation)
          Sets the start of modulation data of this BWF import descriptor, which is taken from the start modulation data property of the associated <qlty> chunk.
 
Methods inherited from class tv.amwa.maj.entity.ImportDescriptor
setPropertiesFromInterface
 
Methods inherited from class tv.amwa.maj.entity.PhysicalDescriptor
setPropertiesFromInterface
 
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.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

BWFIMPORTDESCRIPTOR_TAG

public static final String BWFIMPORTDESCRIPTOR_TAG
See Also:
Constant Field Values
Constructor Detail

BWFImportDescriptor

public BWFImportDescriptor()

Creates and initializes a new BWF import descriptor, which specifies audio data essence according to the Broadcast Wave specifications.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(BWFImportDescriptor castFrom)
See Also:
InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)

getBasicData

@AAFProperty(uuid1=67241218,
             uuid2=513,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="QltyBasicData",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=15650)
public String getBasicData()
                    throws PropertyNotPresentException
Description copied from interface: BWFImportDescriptor

Returns the basic data of this BWF import descriptor, which is taken from the basic data property of the associated <qlty> chunk. This property is optional.

Specified by:
getBasicData in interface BWFImportDescriptor
Returns:
Basic data of this BWF import descriptor.
Throws:
PropertyNotPresentException - The optional basic data property is not present in this BWF import descriptor.

setBasicData

public void setBasicData(String basicData)
Description copied from interface: BWFImportDescriptor

Sets the basic data of this BWF import descriptor, which is taken from the basic data property of the associated <qlty> chunk. This property is optional and setting it to null will omit the property.

Specified by:
setBasicData in interface BWFImportDescriptor
Parameters:
basicData - Basic data of this BWF import descriptor.

getCodingHistory

@AAFProperty(uuid1=67241218,
             uuid2=257,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="BextCodingHistory",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=15649)
public String getCodingHistory()
                        throws PropertyNotPresentException
Description copied from interface: BWFImportDescriptor

Returns the coding history property of this BWF import descriptor, which is taken from the coding history property of the associated <bext> chunk. This property is optional.

Specified by:
getCodingHistory in interface BWFImportDescriptor
Returns:
Coding history property of this BWF import descriptor.
Throws:
PropertyNotPresentException - The optional coding history property is not present in this BWF import descriptor.

setCodingHistory

public void setCodingHistory(String codingHistory)
Description copied from interface: BWFImportDescriptor

Sets the coding history property of this BWF import descriptor, which is taken from the coding history property of the associated <bext> chunk. This property is optional and setting it to null will omit the property.

Specified by:
setCodingHistory in interface BWFImportDescriptor
Parameters:
codingHistory - Coding history property of this BWF import descriptor.

getCueSheet

@AAFProperty(uuid1=67241218,
             uuid2=2049,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="QltyCueSheet",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=15656)
public String getCueSheet()
                   throws PropertyNotPresentException
Description copied from interface: BWFImportDescriptor

Returns the cue sheet property of this BWF import descriptor, which is taken from the cue sheet data property of the associated <qlty> chunk. This property is optional

Specified by:
getCueSheet in interface BWFImportDescriptor
Returns:
Cue sheet property of this BWF import descriptor.
Throws:
PropertyNotPresentException - The optional cue sheet property is not present in this BWF import descriptor.

setCueSheet

public void setCueSheet(String cueSheet)
Description copied from interface: BWFImportDescriptor

Sets the cue sheet property of this BWF import descriptor, which is taken from the cue sheet data property of the associated <qlty> chunk. This property is optional and setting it to null will omit the property.

Specified by:
setCueSheet in interface BWFImportDescriptor
Parameters:
cueSheet - Cue sheet property of this BWF import descriptor.

getEndOfModulation

@AAFProperty(uuid1=67241218,
             uuid2=1281,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="QltyEndOfModulation",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=15653)
public String getEndOfModulation()
                          throws PropertyNotPresentException
Description copied from interface: BWFImportDescriptor

Returns the end of modulation property of this BWF import descriptor, which is taken from the end modulation data property of the associated <qlty> chunk. This property is optional.

Specified by:
getEndOfModulation in interface BWFImportDescriptor
Returns:
End of modulation property of this BWF import descriptor.
Throws:
PropertyNotPresentException - The optional end of modulation property is not present in this BWF import descriptor.

setEndOfModulation

public void setEndOfModulation(String endOfModulation)
Description copied from interface: BWFImportDescriptor

Sets the end of modulation property of this BWF import descriptor, which is taken from the end modulation data property of the associated <qlty> chunk. This property is optional and setting it to null will omit the property.

Specified by:
setEndOfModulation in interface BWFImportDescriptor
Parameters:
endOfModulation - End of modulation property of this BWF import descriptor.

getFileSecurityReport

@AAFProperty(uuid1=67240706,
             uuid2=1280,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="QltyFileSecurityReport",
             typeName="UInt32",
             optional=true,
             uniqueIdentifier=false,
             pid=15637)
public int getFileSecurityReport()
                          throws PropertyNotPresentException
Description copied from interface: BWFImportDescriptor

Returns the file security code of the quality report of this BWF import descriptor. This property is optional.

Specified by:
getFileSecurityReport in interface BWFImportDescriptor
Returns:
File security code of the quality report of this BWF import descriptor.
Throws:
PropertyNotPresentException - The optional file security code value is not present in this BWF import descriptor.

setFileSecurityReport

public void setFileSecurityReport(Integer fileSecurityReport)
Description copied from interface: BWFImportDescriptor

Set the file security code of the quality report of this BWF import descriptor. This property is optional and can be omitted by setting its value to null.

Specified by:
setFileSecurityReport in interface BWFImportDescriptor
Parameters:
fileSecurityReport - File security code of the quality report of this BWF import descriptor.

getFileSecurityWave

@AAFProperty(uuid1=67240706,
             uuid2=1536,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="QltyFileSecurityWave",
             typeName="UInt32",
             optional=true,
             uniqueIdentifier=false,
             pid=15638)
public int getFileSecurityWave()
                        throws PropertyNotPresentException
Description copied from interface: BWFImportDescriptor

Returns the file security code of the BWF wave data of this BWF import descriptor. This property is optional.

Specified by:
getFileSecurityWave in interface BWFImportDescriptor
Returns:
File security code of the BWF wave data of this BWF import descriptor.
Throws:
PropertyNotPresentException - The optional file security wave property is not present in this BWF import descriptor.

setFileSecurityWave

public void setFileSecurityWave(Integer fileSecurityWave)
Description copied from interface: BWFImportDescriptor

Sets the file security code of the BWF wave data of this BWF import descriptor. This property is optional and can be omitted by setting its value to null.

Specified by:
setFileSecurityWave in interface BWFImportDescriptor
Parameters:
fileSecurityWave - File security code of the BWF wave data of this BWF import descriptor.

getOperatorComment

@AAFProperty(uuid1=67241218,
             uuid2=1793,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="QltyOperatorComment",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=15655)
public String getOperatorComment()
                          throws PropertyNotPresentException
Description copied from interface: BWFImportDescriptor

Returns the operator comment property of this BWF import descriptor, which is taken from the comment of operator property of the associated <qlty> chunk. This property is optional.

Specified by:
getOperatorComment in interface BWFImportDescriptor
Returns:
Operator comment property of this BWF import descriptor.
Throws:
PropertyNotPresentException - The optional operator comment property is not present in this BWF import descriptor.

setOperatorComment

public void setOperatorComment(String operatorComment)
Description copied from interface: BWFImportDescriptor

Sets the operator comment property of this BWF import descriptor, which is taken from the comment of operator property of the associated <qlty> chunk. This property is optional and setting it to null will omit the property.

Specified by:
setOperatorComment in interface BWFImportDescriptor
Parameters:
operatorComment - Operator comment of this BWF import descriptor.

getQualityEvent

@AAFProperty(uuid1=67241218,
             uuid2=1025,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="QltyQualityEvent",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=15652)
public String getQualityEvent()
                       throws PropertyNotPresentException
Description copied from interface: BWFImportDescriptor

Returns the quality event data property of this BWF import descriptor, which is taken from the quality event data property of the associated <qlty> chunk. This property is optional.

Specified by:
getQualityEvent in interface BWFImportDescriptor
Returns:
Quality event data property of this BWF import descriptor.
Throws:
PropertyNotPresentException - The optional quality event property is not present in this BWF import descriptor.

setQualityEvent

public void setQualityEvent(String qualityEvent)
Description copied from interface: BWFImportDescriptor

Sets the quality event data property of this BWF import descriptor, which is taken from the quality event data property of the associated <qlty> chunk. This property is optional and setting it to null will omit the property.

Specified by:
setQualityEvent in interface BWFImportDescriptor
Parameters:
qualityEvent - Quality event data property of this BWF import descriptor.

getQualityParameter

@AAFProperty(uuid1=67241218,
             uuid2=1537,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="QltyQualityParameter",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=15654)
public String getQualityParameter()
                           throws PropertyNotPresentException
Description copied from interface: BWFImportDescriptor

Returns the quality parameter property of this BWF import descriptor, which is taken from the quality parameter data property of the associated <qlty> chunk. This property is optional.

Specified by:
getQualityParameter in interface BWFImportDescriptor
Returns:
Quality parameter property of this BWF import descriptor
Throws:
PropertyNotPresentException - The optional quality parameter property is not present in this BWF import descriptor.

setQualityParameter

public void setQualityParameter(String qualityParameter)
Description copied from interface: BWFImportDescriptor

Sets the quality parameter property of this BWF import descriptor, which is taken from the quality parameter data property of the associated <qlty> chunk. This property is optional and setting it to null will omit the property.

Specified by:
setQualityParameter in interface BWFImportDescriptor
Parameters:
qualityParameter - Quality parameter property of this BWF import descriptor.

getStartOfModulation

@AAFProperty(uuid1=67241218,
             uuid2=769,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="QltyStartOfModulation",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=15651)
public String getStartOfModulation()
                            throws PropertyNotPresentException
Description copied from interface: BWFImportDescriptor

Returns the start of modulation data of this BWF import descriptor, which is taken from the start modulation data poperty of the associated <qlty> chunk. This property is optional.

Specified by:
getStartOfModulation in interface BWFImportDescriptor
Returns:
Start of modulation data of this BWF import descriptor.
Throws:
PropertyNotPresentException - The optional start of modulation property is not present in this BWF import descriptor.

setStartOfModulation

public void setStartOfModulation(String startOfModulation)
Description copied from interface: BWFImportDescriptor

Sets the start of modulation data of this BWF import descriptor, which is taken from the start modulation data property of the associated <qlty> chunk. This property is optional and setting it to null will omit the property.

Specified by:
setStartOfModulation in interface BWFImportDescriptor
Parameters:
startOfModulation - Start of modulation data of this BWF import descriptor.

getUnknownBWFChunks

@AAFProperty(uuid1=100729092,
             uuid2=1551,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,8},
             definedName="UnknownBWFChunks",
             typeName="StrongReferenceVector of RIFFChunk",
             optional=true,
             uniqueIdentifier=false,
             pid=15667)
public List<RIFFChunk> getUnknownBWFChunks()
Description copied from interface: BWFImportDescriptor

Returns a copy of the list of unknown BWF chunks of this BWF import descriptor.

Specified by:
getUnknownBWFChunks in interface BWFImportDescriptor
Returns:
Copy of the list of unknown BWF chunks of this BWF import descriptor.

appendUnknownBWFChunk

public void appendUnknownBWFChunk(RIFFChunk chunk)
                           throws NullPointerException,
                                  ObjectAlreadyAttachedException
Description copied from interface: BWFImportDescriptor

Append a RIFFChunk to end of the list of unknown BWF chunks of this BWF import descriptor.

Specified by:
appendUnknownBWFChunk in interface BWFImportDescriptor
Parameters:
chunk - Chunk to append to the current list.
Throws:
NullPointerException - The chunk argument is null.
ObjectAlreadyAttachedException - The chunk is already contained within the list of unknown BWF chunks of this BWF import descriptor.

countUnknownBWFChunks

public int countUnknownBWFChunks()
Description copied from interface: BWFImportDescriptor

Returns the total number of unknown BWF chunks attached to this BWF import descriptor.

Specified by:
countUnknownBWFChunks in interface BWFImportDescriptor
Returns:
Number of unknown BWF chunks attached to this BWF descriptor.

getUnknownBWFChunkAt

public RIFFChunk getUnknownBWFChunkAt(int index)
                               throws IndexOutOfBoundsException
Description copied from interface: BWFImportDescriptor

Returns the RIFFChunk from the list of unknown BWF chunks of this BWF import descriptor at the given index.

Specified by:
getUnknownBWFChunkAt in interface BWFImportDescriptor
Parameters:
index - Index of the chunk to retrieve.
Returns:
Chunk at the given index into the list of unknown BWF chunks of this BWF import descriptor.
Throws:
IndexOutOfBoundsException - The given index is outside the acceptable range for the current list of unknown BWF chunks of this BWF import descriptor.

insertUnknownBWFChunkAt

public void insertUnknownBWFChunkAt(int index,
                                    RIFFChunk chunk)
                             throws NullPointerException,
                                    IndexOutOfBoundsException,
                                    ObjectAlreadyAttachedException
Description copied from interface: BWFImportDescriptor

Insert a RIFFChunk into the list of unknown BWF chunks of this BWF import descriptor at the given index. Chunks already existing at the given and higher indices will be moved to the next higher index to accommodate the new chunk.

Specified by:
insertUnknownBWFChunkAt in interface BWFImportDescriptor
Parameters:
index - Index through the list of unknown BWF chunks at which to insert the additional chunk.
chunk - Chunk to insert at the given index.
Throws:
NullPointerException - The chunk argument is null.
IndexOutOfBoundsException - The given index is outside the acceptable range for the current list of unknown BWF chunks of this BWF import descriptor.
ObjectAlreadyAttachedException - The given chunk is already contained in the list of unknown BWF chunks of this BWF import descriptor.

prependUnknownBWFChunk

public void prependUnknownBWFChunk(RIFFChunk chunk)
                            throws NullPointerException,
                                   ObjectAlreadyAttachedException
Description copied from interface: BWFImportDescriptor

Prepend a RIFFChunk to the beginning of the list of unknown BWF chunks of this BWF descriptor.

Specified by:
prependUnknownBWFChunk in interface BWFImportDescriptor
Parameters:
chunk - Chunk to prepend to the current list.
Throws:
NullPointerException - The chunk argument is null.
ObjectAlreadyAttachedException - The The chunk is already contained within the list of unknown BWF chunks of this BWF import descriptor.

removeUnknownBWFChunkAt

public void removeUnknownBWFChunkAt(int index)
                             throws IndexOutOfBoundsException
Description copied from interface: BWFImportDescriptor

Removes the RIFFChunk at the given index through the list of unknown BWF chunks of this BWF descriptor. Chunks already existing at indices higher than the given index will be moved to the next lower index to fill the gap left by the removal.

Specified by:
removeUnknownBWFChunkAt in interface BWFImportDescriptor
Parameters:
index - Index of the chunk to remove.
Throws:
IndexOutOfBoundsException - The given index is outside the acceptable range for the current list of unknown BWF chunks of this BWF import 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 ImportDescriptor
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 EssenceDescriptor
Returns:
Hash code value for this interchange object.
See Also:
Object.hashCode()

clone

public BWFImportDescriptor 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 ImportDescriptor
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 ImportDescriptor
Parameters:
parent - XML parent element to append child nodes to.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.