tv.amwa.maj.entity
Class CommentMarker

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.Component
          tv.amwa.maj.entity.Segment
              tv.amwa.maj.entity.Event
                  tv.amwa.maj.entity.CommentMarker

All Implemented Interfaces:

Serializable, Cloneable, MAJCommon, CommentMarker, Component, Event, InterchangeObject, Segment, XMLSerializable

Direct Known Subclasses:

DescriptiveMarker

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=2048,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="CommentMarker",
          description="The CommentMarker class specifies a user comment that is associated with a point in time.")
public class CommentMarker
extends Event
implements CommentMarker, Serializable, Cloneable, MAJCommon

Implements a user comment associated with a point in time. A comment marker may have a source reference that specifies a text or audio annotation.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class

CommentMarker.XMLHandler

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

Event.EventXMLHandler

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

COMMENTMARKER_TAG

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

EVENT_ITEM

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

COMPONENT_ITEM

Constructor Summary

CommentMarker(DataDefinition dataDefinition)
Creates and initializes a commment marker for the given kind of essence data, which specifies a user comment that is associated with a point in time.

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.
CommentMarker	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.
SourceReferenceSegment	getAnnotation() Returns the annotation for this comment marker, which specifies a text or audio annotation.
int	hashCode() Returns a hash code value for this interchange object.
void	setAnnotation(SourceReferenceSegment annotation) Sets the annotation marker for this comment marker, which specifies a text or audio annotation.
void	setPropertiesFromInterface(CommentMarker castFrom)

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

getComment, getPosition, getPositionPresent, setComment, setPosition, setPositionPresent, setPropertiesFromInterface

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

getComment, getPosition, setComment, setPosition

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

COMMENTMARKER_TAG

public static final String COMMENTMARKER_TAG

See Also:

Constant Field Values

Constructor Detail

CommentMarker

public CommentMarker(DataDefinition dataDefinition)
              throws NullPointerException

Creates and initializes a commment marker for the given kind of essence data, which specifies a user comment that is associated with a point in time. If this event is in an event mob slot, the position must also be set using Event.setPosition(long). Call setAnnotation(SourceReferenceSegment) to set the optional annotation.

Parameters:

dataDefinition - Kind of data represented by this component.

Throws:

NullPointerException - Argument is null.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(CommentMarker castFrom)

See Also:

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

getAnnotation

@AAFProperty(uuid1=100729092,
             uuid2=522,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="Annotation",
             typeName="StrongReference to SourceReference",
             optional=true,
             uniqueIdentifier=false,
             pid=2305)
public SourceReferenceSegment getAnnotation()
                                     throws PropertyNotPresentException

Description copied from interface: CommentMarker

Returns the annotation for this comment marker, which specifies a text or audio annotation. This is an optional property.

Specified by:

getAnnotation in interface CommentMarker

Returns:

Text or audio annotation.

Throws:

PropertyNotPresentException - The optional annotation property is not present in this comment marker.

setAnnotation

public void setAnnotation(SourceReferenceSegment annotation)

Description copied from interface: CommentMarker

Sets the annotation marker for this comment marker, which specifies a text or audio annotation. Set this value to null to omit this optional property.

Specified by:

setAnnotation in interface CommentMarker

Parameters:

annotation - Specifies a text or audio annotation.

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 Event

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 Event

Returns:

Hash code value for this interchange object.

See Also:

Object.hashCode()

clone

public CommentMarker 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 Event

Parameters:

parent - XML parent element to append child nodes to.