tv.amwa.maj.entity
Class AuxiliaryDescriptor

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

All Implemented Interfaces:

Serializable, Cloneable, MAJCommon, AuxiliaryDescriptor, EssenceDescriptor, InterchangeObject, PhysicalDescriptor, XMLSerializable

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=19968,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="AuxiliaryDescriptor",
          description="The AuxiliaryDescriptor class specifies describes an auxiliary file essence source.")
public class AuxiliaryDescriptor
extends PhysicalDescriptor
implements AuxiliaryDescriptor, Serializable, Cloneable, MAJCommon

Implements the description of an auxiliary file essence source. The type of data in the essence is given by a mime type. See the IANA register of media types.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class

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

AuxiliaryDescriptor(String mimeType)
Creates and initializes a new auxilary descriptor with the given mime type.

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.
AuxiliaryDescriptor	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.
String	getCharSet() Gets the registered character set used by the internal and external representation of the data as per RFC 2048.
String	getMimeType() Gets the registered mime type of the data in the auxiliary file as per RFC 2046 (MIME media types) and RFC 2048 (MIME registration prodcedures).
int	hashCode() Returns a hash code value for this interchange object.
void	setCharSet(String charSet) Sets the registered character set used by the internal and external representation of the data as per RFC 2048.
void	setMimeType(String mimeType) Sets the registered mime type of the data in the auxiliary file as per RFC 2046 and RFC 2048.
void	setPropertiesFromInterface(AuxiliaryDescriptor castFrom)

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

Constructor Detail

AuxiliaryDescriptor

public AuxiliaryDescriptor(@AAFString
                           String mimeType)
                    throws NullPointerException

Creates and initializes a new auxilary descriptor with the given mime type.

Parameters:

mimeType - Registered mimetype of the data in the auxiliary file, according to RFC 2046 (MIME Media Types) and RFC 2048 (MIME Registration Procedures).

Throws:

NullPointerException - Argument is null.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(AuxiliaryDescriptor castFrom)

See Also:

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

getCharSet

@AAFProperty(uuid1=67699456,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,8},
             definedName="CharSet",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=19986)
public String getCharSet()
                  throws PropertyNotPresentException

Description copied from interface: AuxiliaryDescriptor

Gets the registered character set used by the internal and external representation of the data as per RFC 2048. See the IANA register of character sets. Example: "ISO-8859-1". This is an optional property.

Specified by:

getCharSet in interface AuxiliaryDescriptor

Returns:

The registered character set used by the internal and external representation of the data.

Throws:

PropertyNotPresentException - The optional character set is not present for this auxiliary descriptor.

setCharSet

public void setCharSet(String charSet)

Description copied from interface: AuxiliaryDescriptor

Sets the registered character set used by the internal and external representation of the data as per RFC 2048. See the IANA register of character sets. Example: "ISO-8859-1". Set to null to omit this optional property.

Specified by:

setCharSet in interface AuxiliaryDescriptor

Parameters:

charSet - Specifies the registered character set used by the internal and external representation of the data.

getMimeType

@AAFProperty(uuid1=67699201,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,7},
             definedName="MimeType",
             typeName="String",
             optional=false,
             uniqueIdentifier=false,
             pid=19985)
public String getMimeType()

Description copied from interface: AuxiliaryDescriptor

Gets the registered mime type of the data in the auxiliary file as per RFC 2046 (MIME media types) and RFC 2048 (MIME registration prodcedures).

Specified by:

getMimeType in interface AuxiliaryDescriptor

Returns:

The registered mimetype of the data in the auxiliary file.

setMimeType

public void setMimeType(String mimeType)
                 throws NullPointerException

Description copied from interface: AuxiliaryDescriptor

Sets the registered mime type of the data in the auxiliary file as per RFC 2046 and RFC 2048.

Specified by:

setMimeType in interface AuxiliaryDescriptor

Parameters:

mimeType - Specifies the registered mimetype of the data in the auxiliary file.

Throws:

NullPointerException - The given mime type is null.

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