tv.amwa.maj.entity
Class Parameter

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.Parameter

All Implemented Interfaces:

Serializable, Cloneable, MAJCommon, InterchangeObject, Parameter, XMLSerializable

Direct Known Subclasses:

ConstantValue, VaryingValue

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=15360,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="Parameter",
          description="The Parameter class specifies an effect control value.")
public abstract class Parameter
extends InterchangeObject
implements Parameter, Serializable, Cloneable, MAJCommon

Implements an effect control value. Effect control values are parameters to operations specified by operation groups.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class

Parameter.ParameterXMLHandler

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

InterchangeObject.InterchangeObjectXMLHandler

Constructor Summary

Parameter()

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.
Parameter	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.
AUID	getDefinitionValue() Returns the unique identifier for the parameter definition of this parameter.
long	getId()
ParameterDefinition	getParameterDefinition() Returns the parameter definition of this operation parameter.
TypeDefinition	getTypeDefinition() Returns the type definition of the data value of this parameter.
int	hashCode() Returns a hash code value for this interchange object.
void	setId(long id)
void	setParameterDefinition(ParameterDefinition parameterDefinition)
void	setPropertiesFromInterface(Parameter castFrom)

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

Parameter

public Parameter()

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(Parameter castFrom)

getParameterDefinition

public ParameterDefinition getParameterDefinition()

Description copied from interface: Parameter

Returns the parameter definition of this operation parameter.

Specified by:

getParameterDefinition in interface Parameter

Returns:

Parameter definition of this operation parameter.

See Also:

ParameterDefinition.forIdentification(tv.amwa.maj.record.AUID), DefinitionObject.getAUID()

setParameterDefinition

public void setParameterDefinition(ParameterDefinition parameterDefinition)
                            throws NullPointerException

Throws:

NullPointerException

getDefinitionValue

@AAFProperty(uuid1=100729092,
             uuid2=260,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="Definition",
             typeName="AUID",
             optional=false,
             uniqueIdentifier=false,
             pid=19457)
public AUID getDefinitionValue()

Returns the unique identifier for the parameter definition of this parameter.

Returns:

Unique identifier for the parameter definition of this parameter.

getTypeDefinition

public TypeDefinition getTypeDefinition()

Description copied from interface: Parameter

Returns the type definition of the data value of this parameter. It is often an integer or rational value and the value may vary with time.

Note that the type definition is stored in the base class because it should be the same for all control points inside of a varying value.

Specified by:

getTypeDefinition in interface Parameter

Returns:

Type definition of the data value inside the parameter.

See Also:

Parameter.getParameterDefinition(), ParameterDefinition.getTypeDefinition()

getId

public long getId()

setId

public void setId(long id)

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 Object

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 Object

Returns:

Hash code value for this interchange object.

See Also:

Object.hashCode()

clone

public Parameter 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 Object

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 InterchangeObject

Parameters:

parent - XML parent element to append child nodes to.