tv.amwa.maj.entity
Class InterpolationDefinition

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.DefinitionObject
          tv.amwa.maj.entity.InterpolationDefinition

All Implemented Interfaces:

Serializable, Cloneable, InterpolationConstant, DefinitionType, MAJCommon, DefinitionObject, InterchangeObject, InterpolationDefinition, XMLSerializable

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=8448,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="InterpolationDefinition",
          description="The InterpolationDefinition class specifies the mechanism used to calculate the values produced by a VaryingValue using the specified ControlPoints.")
public class InterpolationDefinition
extends DefinitionObject
implements InterpolationDefinition, Serializable, InterpolationConstant, Cloneable, MAJCommon

Implements a definition for the mechanism used to calculate the values produced by a varying value using the specified control points.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class

InterpolationDefinition.XMLHandler

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

DefinitionObject.DefinitionObjectXMLHandler

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

InterchangeObject.InterchangeObjectXMLHandler

Field Summary

Fields inherited from interface tv.amwa.maj.constant.InterpolationConstant

BSpline, Constant, Linear, Log, None, Power

Constructor Summary

InterpolationDefinition(AUID identification, String name)
Creates and initalizes a new interpolation definition, which specifies the mechanism used to calculate the values produced by a varying value using the specified control points.

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.
InterpolationDefinition	clone() Creates a cloned copy of this entity.
static InterpolationDefinition	forIdentification(AUID identification)
static InterpolationDefinition	forName(String interpolationName)
String	getLocalizedUID()
static boolean	registerInterpolationDefinition(InterpolationDefinition definedInterpolation)
static int	registerInterpolationsFromClass(Class<?> classWithInterpolations)
void	setPropertiesFromInterface(InterpolationDefinition castFrom)

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

equals, getAUID, getDescription, getName, hashCode, setDescription, setLocalizedUID, setName

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

getAUID, getDescription, getName, setDescription, setName

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

equals, hashCode, toString

Constructor Detail

InterpolationDefinition

public InterpolationDefinition(AUID identification,
                               @AAFString
                               String name)
                        throws NullPointerException

Creates and initalizes a new interpolation definition, which specifies the mechanism used to calculate the values produced by a varying value using the specified control points.

Parameters:

identification - Unique identifier for this interpolation.

name - Display name for the interpolation.

Throws:

NullPointerException - One or both of the arguments is null.

Method Detail

registerInterpolationsFromClass

public static final int registerInterpolationsFromClass(Class<?> classWithInterpolations)
                                                 throws NullPointerException

Throws:

NullPointerException

registerInterpolationDefinition

public static final boolean registerInterpolationDefinition(InterpolationDefinition definedInterpolation)
                                                     throws NullPointerException

Throws:

NullPointerException

forName

public static final InterpolationDefinition forName(String interpolationName)
                                             throws NullPointerException

Throws:

NullPointerException

forIdentification

public static final InterpolationDefinition forIdentification(AUID identification)
                                                       throws NullPointerException

Throws:

NullPointerException

setPropertiesFromInterface

public final void setPropertiesFromInterface(InterpolationDefinition castFrom)

See Also:

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

clone

public InterpolationDefinition 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 DefinitionObject

Returns:

Independent clone of this value, which is a deep copy.

See Also:

Object.clone()

getLocalizedUID

public String getLocalizedUID()

Overrides:

getLocalizedUID in class DefinitionObject

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 DefinitionObject

Parameters:

parent - XML parent element to append child nodes to.