PropertyDefinition (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.meta
Class PropertyDefinition

java.lang.Object
  tv.amwa.maj.meta.MetaDefinition
      tv.amwa.maj.meta.PropertyDefinition

All Implemented Interfaces:: Serializable, DefinitionType, MetaDefinition, PropertyDefinition, XMLSerializable, MAJCommon

@AAFClass(uuid1=218169601, uuid2=514, uuid3=0, uuid4={6,14,43,52,2,6,1,1}, definedName="PropertyDefinition", description="The PropertyDefinition class describes properties allowed for a class.") public final class PropertyDefinition
extends MetaDefinition
implements PropertyDefinition, Serializable, XMLSerializable
extends MetaDefinition
implements PropertyDefinition, Serializable, XMLSerializable

Implementation of a AAF property definition, which describes properties allowed for a class.

The preferred method of creating and managing property definitions in this Java implementation is by annotating get methods on class implementations with the AAFProperty annotation. Property definitions are then created and attached to their appropriate class definition using ClassDefinition.forClass(Class).

Author:: Richard Cartwright
See Also:: PropertyDefinition, AAFProperty, InterchangeObject.getProperties(), PropertyValue, Serialized Form

Nested Class Summary
`static class`	`PropertyDefinition.XMLHandler`

Constructor Summary
`PropertyDefinition(AUID identification, String name, TypeDefinition type, ClassDefinition memberOf, boolean isOptional)` Creates and initializes a new property definition, which describes an allowed property of a `class definition`.

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.
`boolean`	`deepEquals(Object o)` Tests if all the properties of this property definition are equals to all the properties of the given object.
`Method`	`getAnnotatedMethod()`
`boolean`	`getIsOptional()` Returns `true` for a property that is optional and `false` for a mandatory property.
`boolean`	`getIsUniqueIdentifier()` Returns `true` for a property that provides a unique identifier for its associated object; otherwise `false`.
`short`	`getLocalIdentification()` Returns the local identification associated with this property definition, which is used to identify the property within the scope of its associated class, as returned by `PropertyDefinition.getMemberOf()`.
`ClassDefinition`	`getMemberOf()` Returns the class definition for the class that this property definition defines a property for.
`TypeDefinition`	`getTypeDefinition()` Returns the property type of the defined property.
`void`	`setAnnotatedMethod(Method annotatedMethod)`
`void`	`setPropertiesFromInterface(PropertyDefinition castFrom)` Set the value of the properties of this property definition using any class that implements `PropertyDefinition`.

Methods inherited from class tv.amwa.maj.meta.MetaDefinition
`castFromInterface, equals, getAUID, getDescription, getIdentification, getName, hashCode, setDescription, setName, setPropertiesFromInterface, toString`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface tv.amwa.maj.iface.MetaDefinition
`getAUID, getDescription, getName, setDescription, setName`

Constructor Detail

PropertyDefinition

public PropertyDefinition(AUID identification,
                          @AAFString
                          String name,
                          TypeDefinition type,
                          ClassDefinition memberOf,
                          @Bool
                          boolean isOptional)
                   throws NullPointerException

Creates and initializes a new property definition, which describes an allowed property of a class definition.

It is not normally necessary to create property definitions directly as they are available through methods of ClassDefinition. To extend the AAF object model with user defined classes, the AAFProperty annotation can be used to automatically generate property definitions.

Parameters:: identification - Unique identifier for the new property definition.; name - Display name of the new property definition.; type - Property type for the new property definition.; memberOf - Reference to the class this property is a member of, or null if this property is not associated with a class.; isOptional - Can an object omit a value for this property?
Throws:: NullPointerException - One of the identification, name or type arguments is/are null and they are all required in this implementation.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(PropertyDefinition castFrom)

Set the value of the properties of this property definition using any class that implements PropertyDefinition.

Parameters:: castFrom - Object to use to set property values from.
See Also:: MetaDefinition.setPropertiesFromInterface(tv.amwa.maj.iface.MetaDefinition)