Media Authoring
with Java API

tv.amwa.maj.entity
Class GPITrigger

java.lang.Object
  extended by tv.amwa.maj.entity.InterchangeObject
      extended by tv.amwa.maj.entity.Component
          extended by tv.amwa.maj.entity.Segment
              extended by tv.amwa.maj.entity.Event
                  extended by tv.amwa.maj.entity.GPITrigger
All Implemented Interfaces:
Serializable, Cloneable, MAJCommon, Component, Event, GPITrigger, InterchangeObject, Segment, XMLSerializable

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=1792,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="GPITrigger",
          description="The GPITrigger class specifies a trigger action that should be taken when the GPITrigger is reached.")
public class GPITrigger
extends Event
implements GPITrigger, Serializable, Cloneable, MAJCommon

Implements a trigger action that should be taken when the GPI trigger is reached.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:
Richard Cartwright
See Also:
Serialized Form

Nested Class Summary
static class GPITrigger.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 GPITRIGGER_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
GPITrigger(DataDefinition dataDefinition, boolean activeState)
          Creates and initializes a new GPI trigger event, which specifies a trigger action that should be taken when the GPITrigger is reached.
 
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.
 GPITrigger 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.
 boolean getActiveState()
          Returns the active state of this GPI trigger, which is true if the event is "on".
 int hashCode()
          Returns a hash code value for this interchange object.
 void setActiveState(boolean activeState)
          Set to true to turn the trigger "on" or false to turn the trigger off.
 void setPropertiesFromInterface(GPITrigger 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

GPITRIGGER_TAG

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

GPITrigger

public GPITrigger(DataDefinition dataDefinition,
                  @Bool
                  boolean activeState)
           throws NullPointerException

Creates and initializes a new GPI trigger event, which specifies a trigger action that should be taken when the GPITrigger is reached. If this event is located in an event mob slot, its position must also be set using Event.setPosition(long).

Parameters:
dataDefinition - Kind of data represented by this component.
activeState - Is the event turned on?
Throws:
NullPointerException - Data definition argument is null.
Method Detail

setPropertiesFromInterface

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

getActiveState

@AAFProperty(uuid1=87032833,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="ActiveState",
             typeName="Boolean",
             optional=false,
             uniqueIdentifier=false,
             pid=2049)
public boolean getActiveState()
Description copied from interface: GPITrigger

Returns the active state of this GPI trigger, which is true if the event is "on".

Specified by:
getActiveState in interface GPITrigger
Returns:
Active state of this trigger.

setActiveState

public void setActiveState(boolean activeState)
Description copied from interface: GPITrigger

Set to true to turn the trigger "on" or false to turn the trigger off.

Specified by:
setActiveState in interface GPITrigger
Parameters:
activeState - Active state to set for the trigger.

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

Media Authoring
with Java API

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