tv.amwa.maj.entity
Class EdgecodeSegment

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.Component
          tv.amwa.maj.entity.Segment
              tv.amwa.maj.entity.EdgecodeSegment

All Implemented Interfaces:

Serializable, Cloneable, MAJCommon, Component, EdgecodeSegment, InterchangeObject, Segment, XMLSerializable

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=1024,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="EdgecodeSegment",
          description="The Edgecode class stores film edge code information.")
public class EdgecodeSegment
extends Segment
implements EdgecodeSegment, Serializable, Cloneable, MAJCommon

Implements the storage of film edge code information.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class

EdgecodeSegment.XMLHandler

Nested classes/interfaces inherited from class tv.amwa.maj.entity.Segment

Segment.SegmentXMLHandler

Nested classes/interfaces inherited from class tv.amwa.maj.entity.Component

Component.ComponentAttributesXMLHandler, Component.ComponentUserCommentsXMLHandler, Component.ComponentXMLHandler, Component.KLVDataXMLHandler

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

InterchangeObject.InterchangeObjectXMLHandler

Field Summary

static String

EDGECODE_TAG

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

COMPONENT_ITEM

Constructor Summary

EdgecodeSegment(long length, EdgecodeValue edgecode)
Creates and initializes a new edgecode segment, which stores film edge code information.

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.
EdgecodeSegment	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.
EdgeType	getCodeFormat() Returns the type of edgecode of the underlying edgecode value.
EdgecodeValue	getEdgecode() Returns the edgecode value stored by this edgecode segment.
FilmType	getFilmKind() Returns the type of film of the underlying edgecode value.
byte[]	getHeader() Returns the header of the underlying edgecode value, or an empty byte array if the optional property is not set.
long	getStartFrame() Returns the edgecode at the beginning of the segment.
int	hashCode() Returns a hash code value for this interchange object.
void	setPropertiesFromInterface(EdgecodeSegment castFrom)

Methods inherited from class tv.amwa.maj.entity.Segment

segmentOffsetToTC, segmentTCToOffset, setPropertiesFromInterface

Methods inherited from class tv.amwa.maj.entity.Component

appendAttribute, appendAttribute, appendComment, appendComment, appendKLVData, countAttributes, countComments, countKLVData, getAttributes, getComments, getDataDefinition, getKLVData, getLength, getLengthPresent, removeAttribute, removeComment, removeKLVData, setDataDefinition, setLength, setLengthPresent, 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.Segment

segmentOffsetToTC, segmentTCToOffset

Methods inherited from interface tv.amwa.maj.iface.Component

appendAttribute, appendAttribute, appendComment, appendComment, appendKLVData, countAttributes, countComments, countKLVData, getAttributes, getComments, getDataDefinition, getKLVData, getLength, removeAttribute, removeComment, removeKLVData, setDataDefinition, setLength

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

EDGECODE_TAG

public static final String EDGECODE_TAG

See Also:

Constant Field Values

Constructor Detail

EdgecodeSegment

public EdgecodeSegment(long length,
                       EdgecodeValue edgecode)
                throws NullPointerException,
                       BadLengthException,
                       BadSizeException

Creates and initializes a new edgecode segment, which stores film edge code information.

Parameters:

length - Duration in edit units of this component.

edgecode - Edgecode value for the new edgecode segment.

Throws:

NullPointerException - Edgecode argument is null.

BadLengthException - Cannot set the length of a component to a negative value.

BadSizeException - The given edgecode value has a header that is longer than 8 bytes.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(EdgecodeSegment castFrom)

See Also:

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

getEdgecode

public EdgecodeValue getEdgecode()

Description copied from interface: EdgecodeSegment

Returns the edgecode value stored by this edgecode segment.

Specified by:

getEdgecode in interface EdgecodeSegment

Returns:

Edgecode value of this edgecode segment.

See Also:

makeEdgecodeValue()

getFilmKind

@AAFProperty(uuid1=68157699,
             uuid2=265,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="FilmKind",
             typeName="FilmType",
             optional=false,
             uniqueIdentifier=false,
             pid=1026)
public FilmType getFilmKind()

Returns the type of film of the underlying edgecode value.

Returns:

Type of film of the underlying edgecode value.

See Also:

FilmType

getCodeFormat

@AAFProperty(uuid1=68157699,
             uuid2=258,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="CodeFormat",
             typeName="EdgeType",
             optional=false,
             uniqueIdentifier=false,
             pid=1027)
public EdgeType getCodeFormat()

Returns the type of edgecode of the underlying edgecode value.

Returns:

Type of edgecode of the underlying edgecode value.

See Also:

EdgeType

getHeader

@AAFProperty(uuid1=16974337,
             uuid2=512,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="Header",
             typeName="DataValue",
             optional=true,
             uniqueIdentifier=false,
             pid=1028)
public byte[] getHeader()

Returns the header of the underlying edgecode value, or an empty byte array if the optional property is not set. This implementation limits headers to 8 bytes in length.

Returns:

Header of the underlying edgecode value, or an empty byte array if the optional property is not set.

getStartFrame

@AAFProperty(uuid1=17041665,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="Start",
             typeName="PositionType",
             optional=false,
             uniqueIdentifier=false,
             pid=1025)
public long getStartFrame()

Returns the edgecode at the beginning of the segment.

Returns:

Edgecode and the beginning of the segment.

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 Component

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 Component

Returns:

Hash code value for this interchange object.

See Also:

Object.hashCode()

clone

public EdgecodeSegment 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 Segment

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 Component

Parameters:

parent - XML parent element to append child nodes to.