DataDefinition (MAJ API)

Overview

Package

Class

Tree

Deprecated

Index

Media Authoring
with Java API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

tv.amwa.maj.entity
Class DataDefinition

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

All Implemented Interfaces:: Serializable, Cloneable, DataDefinitionConstant, DefinitionType, MAJCommon, DataDefinition, DefinitionObject, InterchangeObject, XMLSerializable

@AAFClass(uuid1=218169601, uuid2=257, uuid3=6912, uuid4={6,14,43,52,2,6,1,1}, definedName="DataDefinition", description="The DataDefinition class specifies the kind of data that can be stored in a Component.") public class DataDefinition
extends DefinitionObject
implements DataDefinition, Serializable, Cloneable, DataDefinitionConstant, MAJCommon
extends DefinitionObject
implements DataDefinition, Serializable, Cloneable, DataDefinitionConstant, MAJCommon

Implements a definition for the kind of data that can be stored in a component.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:: Richard Cartwright
See Also:: Serialized Form

Nested Class Summary
`static class`	`DataDefinition.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.DataDefinitionConstant
`Auxiliary, DataEssence, DescriptiveMetadata, Edgecode, LegacyPicture, LegacySound, LegacyTimecode, Matte, ParsedText, Picture, PictureWithMatte, Sound, Timecode, Unknown`

Constructor Summary
`DataDefinition(AUID identification, String name)` Creates and initializes the required fields of a data definition, which specifies the kind of data that can be stored in a `component`.

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.
`DataDefinition`	`clone()` Creates a cloned copy of this entity.
`boolean`	`doesDataDefConvertFrom(DataDefinition dataDef)` Returns `true` if data represented by this type of data definition can be created by converting from the type represented by the given data definition.
`boolean`	`doesDataDefConvertTo(DataDefinition dataDef)` Returns `true` if the data represented by this data definition can be converted to the data definition given as an argument.
`static DataDefinition`	`forIdentification(AUID identification)`
`static DataDefinition`	`forName(String dataDefinitionName)`
`String`	`getLocalizedUID()`
`boolean`	`isAuxilaryKind()` Returns `true` if the data definition represents Auxiliary data; otherwise `false`.
`boolean`	`isDataDefOf(DataDefinition dataDef)` Returns `true` is this data definition matches the data definition provided in the parameter; otherwise `false`.
`boolean`	`isDescriptiveMetadataKind()` Returns `true` if the data definition represents data that is descriptive metadata; otherwise `false`.
`boolean`	`isEdgecodeKind()` Returns `true` if the data definition represents data that is a stream of film edge code values; otherwise `false`.
`boolean`	`isMatteKind()` Returns `true` in the data definition is a matte, in other words a stream of essence that contains an image of alpha values; otherwise `false`.
`boolean`	`isPictureKind()` Returns `true` is the data definition is a picture only; otherwise returns `false`.
`boolean`	`isPictureWithMatteKind()` Returns `true` if the data definition is for a picture with a matte; otherwise returns `false`.
`boolean`	`isSoundKind()` Returns `true` is a data definition corresponds to sound data; otherwise returns false.
`boolean`	`isTimecodeKind()` Returns `true` if the data definition represents data that is a stream of tape timecode values; otherwise `false`.
`static boolean`	`registerDataDefinition(DataDefinition definedDataDefinition)`
`static int`	`registerDataDefinitionsFromClass(Class<?> classWithDataDefinitions)`
`void`	`setPropertiesFromInterface(DataDefinition 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, toString, 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

DataDefinition

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

Creates and initializes the required fields of a data definition, which specifies the kind of data that can be stored in a component.

Parameters:: identification - Unique identifier for the data definition.; name - Name for the data definition.
Throws:: NullPointerException - One or both of the arguments is null.

Method Detail

registerDataDefinitionsFromClass

public static final int registerDataDefinitionsFromClass(Class<?> classWithDataDefinitions)
                                                  throws NullPointerException

Throws:: NullPointerException

registerDataDefinition

public static final boolean registerDataDefinition(DataDefinition definedDataDefinition)
                                            throws NullPointerException

Throws:: NullPointerException

forName

public static final DataDefinition forName(String dataDefinitionName)
                                    throws NullPointerException

Throws:: NullPointerException

forIdentification

public static final DataDefinition forIdentification(AUID identification)
                                              throws NullPointerException

Throws:: NullPointerException

setPropertiesFromInterface

public final void setPropertiesFromInterface(DataDefinition castFrom)

See Also:: InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)