tv.amwa.maj.entity
Class TapeDescriptor

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

All Implemented Interfaces:

Serializable, Cloneable, MAJCommon, EssenceDescriptor, InterchangeObject, TapeDescriptor, XMLSerializable

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=11776,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="TapeDescriptor",
          description="The TapeDescriptor class describes audio tape or video tape media.")
public class TapeDescriptor
extends EssenceDescriptor
implements TapeDescriptor, Serializable, Cloneable, MAJCommon

Implements the description of audio tape or video tape media. A source mob described by a tape descriptor is known as a tape source mob.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class

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

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

ESSENCEDESCRIPTOR_ITEM

Constructor Summary

TapeDescriptor()
Creates and initializes a new tape descriptor, which describes audio tape or video tape media.

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.
TapeDescriptor	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.
VideoSignalType	getSignalType() Returns the video signal standard recorded on the described tape.
String	getTapeBatchNumber() Returns the tape batch number for this tape descriptor.
TapeFormatType	getTapeFormat() Returns the recording method used for the described tape, known as its format.
TapeCaseType	getTapeFormFactor() Returns the tape form factor (case size) of the described tape.
int	getTapeLength() Returns the length of the described tape, measured in minutes.
String	getTapeManufacturer() Returns the tape manufacturer property of the tape descriptor, which provides a text string to display to end users that identifies the manufacturer of the tape.
String	getTapeModel() Returns the tape model property of the tape descriptor, which provides a text string to display to end users that identifies the manufacturer's brand designation of the tape.
String	getTapeStock() Returns the string identifying the tape stock for this tape descriptor.
int	hashCode() Returns a hash code value for this interchange object.
void	setPropertiesFromInterface(TapeDescriptor castFrom)
void	setSignalType(VideoSignalType videoSignal) Sets the video signal standard recorded on the described tape.
void	setTapeBatchNumber(String tapeBatchNumber) Sets the tape batch number for this tape descriptor.
void	setTapeFormat(TapeFormatType tapeFormat) Sets the recording method used for the described tape.
void	setTapeFormFactor(TapeCaseType formFactor) Sets the tape form factor (case size) of the described tape.
void	setTapeLength(Integer tapeLength) Sets the length of the described tape, measured in minutes.
void	setTapeManufacturer(String tapeManufacturer) Sets the tape manufacturer property of the tape descriptor, which provides a text string to display to end users that identifies the manufacturer of the tape.
void	setTapeModel(String tapeModel) Sets the tape model property of this tape descriptor, which provides a text string to display to end users that identifies the manufacturer's brand designation of the tape.
void	setTapeStock(String tapeStock) Sets the string identifying the tape stock for this tape descriptor.

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, toString, 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

Constructor Detail

TapeDescriptor

public TapeDescriptor()

Creates and initializes a new tape descriptor, which describes audio tape or video tape media.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(TapeDescriptor castFrom)

getSignalType

@AAFProperty(uuid1=67175425,
             uuid2=256,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="VideoSignal",
             typeName="VideoSignalType",
             optional=true,
             uniqueIdentifier=false,
             pid=14850)
public VideoSignalType getSignalType()
                              throws PropertyNotPresentException

Description copied from interface: TapeDescriptor

Returns the video signal standard recorded on the described tape. This is an optional property.

Typical values includes:

• VideoSignalType.NTSCSignal
• VideoSignalType.PALSignal
• VideoSignalType.SECAMSignal

Specified by:

getSignalType in interface TapeDescriptor

Returns:

Signal standard recorded on the described tape.

Throws:

PropertyNotPresentException - The optional video signal type property is not present in this tape descriptor.

setSignalType

public void setSignalType(VideoSignalType videoSignal)

Description copied from interface: TapeDescriptor

Sets the video signal standard recorded on the described tape. Set this optional property to null to omit it.

Typical values includes:

• VideoSignalType.NTSCSignal
• VideoSignalType.PALSignal
• VideoSignalType.SECAMSignal

Specified by:

setSignalType in interface TapeDescriptor

Parameters:

videoSignal - Signal standard recorded on the described tape.

getTapeFormFactor

@AAFProperty(uuid1=68157697,
             uuid2=257,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="FormFactor",
             typeName="TapeCaseType",
             optional=true,
             uniqueIdentifier=false,
             pid=14849)
public TapeCaseType getTapeFormFactor()
                               throws PropertyNotPresentException

Description copied from interface: TapeDescriptor

Returns the tape form factor (case size) of the described tape. This is an optional property.

Typical values include:

• TapeCaseType.VHSVideoTape
• TapeCaseType.DATCartridge
• TapeCaseType.ThreeFourthInchVideoTape

Specified by:

getTapeFormFactor in interface TapeDescriptor

Returns:

Tape form factor of the described tape.

Throws:

PropertyNotPresentException - The optional tape form factor property is not present in this tape descriptor.

setTapeFormFactor

public void setTapeFormFactor(TapeCaseType formFactor)

Description copied from interface: TapeDescriptor

Sets the tape form factor (case size) of the described tape. Set this optional property to null to omit it.

Typical values include:

• TapeCaseType.VHSVideoTape
• TapeCaseType.DATCartridge
• TapeCaseType.ThreeFourthInchVideoTape

Specified by:

setTapeFormFactor in interface TapeDescriptor

Parameters:

formFactor - Tape form factor (case size) of the described tape.

getTapeFormat

@AAFProperty(uuid1=218169601,
             uuid2=257,
             uuid3=256,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="TapeFormat",
             typeName="TapeFormatType",
             optional=true,
             uniqueIdentifier=false,
             pid=14851)
public TapeFormatType getTapeFormat()
                             throws PropertyNotPresentException

Description copied from interface: TapeDescriptor

Returns the recording method used for the described tape, known as its format. This is an optional property.

Typical values include:

• TapeFormatType.BetacamSPFormat
• TapeFormatType.SVHSFormat
• TapeFormatType._8mmFormat

Specified by:

getTapeFormat in interface TapeDescriptor

Returns:

Recording method used for the described tape.

Throws:

PropertyNotPresentException - The optional tape format property is not present in this tape descriptor.

setTapeFormat

public void setTapeFormat(TapeFormatType tapeFormat)

Description copied from interface: TapeDescriptor

Sets the recording method used for the described tape. Set this optional property to null to omit it.

Typical values include:

• TapeFormatType.BetacamSPFormat
• TapeFormatType.SVHSFormat
• TapeFormatType._8mmFormat

Specified by:

setTapeFormat in interface TapeDescriptor

Parameters:

tapeFormat - Recording method used for the described tape.

getTapeLength

@AAFProperty(uuid1=68157697,
             uuid2=768,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="Length",
             typeName="UInt32",
             optional=true,
             uniqueIdentifier=false,
             pid=14852)
public int getTapeLength()
                  throws PropertyNotPresentException

Description copied from interface: TapeDescriptor

Returns the length of the described tape, measured in minutes. This is an optional property.

Specified by:

getTapeLength in interface TapeDescriptor

Returns:

Length of the described tape in minutes.

Throws:

PropertyNotPresentException - The optional tape length property is not present in this tape descriptor.

setTapeLength

public void setTapeLength(Integer tapeLength)
                   throws IllegalArgumentException

Description copied from interface: TapeDescriptor

Sets the length of the described tape, measured in minutes. Set this optional property to null to omit it.

Specified by:

setTapeLength in interface TapeDescriptor

Parameters:

tapeLength - Length of the described tape measured in minutes.

Throws:

IllegalArgumentException - The given tape length is negative.

getTapeManufacturer

@AAFProperty(uuid1=68157697,
             uuid2=1025,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="ManufacturerID",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=14853)
public String getTapeManufacturer()
                           throws PropertyNotPresentException

Description copied from interface: TapeDescriptor

Returns the tape manufacturer property of the tape descriptor, which provides a text string to display to end users that identifies the manufacturer of the tape. This is an optional property.

Specified by:

getTapeManufacturer in interface TapeDescriptor

Returns:

Tape manufacturer property of the tape descriptor.

Throws:

PropertyNotPresentException - The optional tape manufacturer property is not present in this tape descriptor.

setTapeManufacturer

public void setTapeManufacturer(String tapeManufacturer)

Description copied from interface: TapeDescriptor

Sets the tape manufacturer property of the tape descriptor, which provides a text string to display to end users that identifies the manufacturer of the tape. Set this optional property to null to omit it.

Specified by:

setTapeManufacturer in interface TapeDescriptor

Parameters:

tapeManufacturer - Tape manufacturer property of the tape descriptor.

getTapeModel

@AAFProperty(uuid1=68157697,
             uuid2=513,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="Model",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=14854)
public String getTapeModel()
                    throws PropertyNotPresentException

Description copied from interface: TapeDescriptor

Returns the tape model property of the tape descriptor, which provides a text string to display to end users that identifies the manufacturer's brand designation of the tape. This is an optional property.

Specified by:

getTapeModel in interface TapeDescriptor

Returns:

Tape model of this tape descriptor.

Throws:

PropertyNotPresentException - The optional tape model property is not present in this tape descriptor.

setTapeModel

public void setTapeModel(String tapeModel)

Description copied from interface: TapeDescriptor

Sets the tape model property of this tape descriptor, which provides a text string to display to end users that identifies the manufacturer's brand designation of the tape. Set this optional property to null to omit it.

Specified by:

setTapeModel in interface TapeDescriptor

Parameters:

tapeModel - Tape model of this tape descriptor.

getTapeBatchNumber

@AAFProperty(uuid1=68157697,
             uuid2=1537,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="TapeBatchNumber",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=14855)
public String getTapeBatchNumber()
                          throws PropertyNotPresentException

Description copied from interface: TapeDescriptor

Returns the tape batch number for this tape descriptor. This is an optional property.

Specified by:

getTapeBatchNumber in interface TapeDescriptor

Returns:

Tape batch number for this tape descriptor.

Throws:

PropertyNotPresentException - The optional tape batch number is not present in this tape descriptor.

setTapeBatchNumber

public void setTapeBatchNumber(String tapeBatchNumber)

Description copied from interface: TapeDescriptor

Sets the tape batch number for this tape descriptor.

Specified by:

setTapeBatchNumber in interface TapeDescriptor

Parameters:

tapeBatchNumber - Tape batch number for this tape descriptor.

getTapeStock

@AAFProperty(uuid1=68157697,
             uuid2=1281,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="TapeStock",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=14856)
public String getTapeStock()
                    throws PropertyNotPresentException

Description copied from interface: TapeDescriptor

Returns the string identifying the tape stock for this tape descriptor. This is an optional property.

Specified by:

getTapeStock in interface TapeDescriptor

Returns:

String identifying the tape stock for this tape descriptor.

Throws:

PropertyNotPresentException - The optional tape stock property is not present for this tape descriptor.

setTapeStock

public void setTapeStock(String tapeStock)

Description copied from interface: TapeDescriptor

Sets the string identifying the tape stock for this tape descriptor. Set this optional property to null to omit it.

Specified by:

setTapeStock in interface TapeDescriptor

Parameters:

tapeStock - String identifying the tape stock for this tape 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 EssenceDescriptor

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 TapeDescriptor 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 EssenceDescriptor

Parameters:

parent - XML parent element to append child nodes to.