tv.amwa.maj.entity
Class FilmDescriptor

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.EssenceDescriptor
          tv.amwa.maj.entity.FilmDescriptor

All Implemented Interfaces:

Serializable, Cloneable, MAJCommon, EssenceDescriptor, FilmDescriptor, InterchangeObject, XMLSerializable

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=11520,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="FilmDescriptor",
          description="The FilmDescriptor class describes film media.")
public class FilmDescriptor
extends EssenceDescriptor
implements FilmDescriptor, Serializable, Cloneable, MAJCommon

Implements the description of film media. A SourceMob described by a film descriptor is known as a film source mob.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class

FilmDescriptor.XMLHandler

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

EssenceDescriptor.EssenceDescriptorXMLHandler, EssenceDescriptor.LocatorXMLHandler, EssenceDescriptor.SubDescriptorXMLHandler

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

InterchangeObject.InterchangeObjectXMLHandler

Field Summary

static String

FILMDESCRIPTOR_TAG

Fields inherited from class tv.amwa.maj.entity.EssenceDescriptor

ESSENCEDESCRIPTOR_ITEM

Constructor Summary

FilmDescriptor()
Creates and initializes a film descriptor that describes film media.

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.
FilmDescriptor	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.
Rational	getFilmAspectRatio() Returns the image aspect ratio of this film descriptor, which specifies the ratio between the horizontal size of the frame image and the vertical size of the frame image.
String	getFilmBatchNumber() Returns the film batch number for this film descriptor.
FilmType	getFilmFormat() Returns the film format of this film descriptor, according to its film type.
String	getFilmGaugeFormat() Returns the film gauge format of this film descriptor.
String	getFilmManufacturer() Returns the film manufacturer associated with this film descriptor which is a string to display to end users, indicating the manufacturer of the film.
String	getFilmModel() Returns the film model associated with this film descriptor, which is a string to display to end users indicating the manufacturerÕs brand designation for the film, such as "5247".
int	getFrameRate() Returns the frame rate of this film descriptor, which specifies the frame rate of the film measured in frames per second.
byte	getPerfortionsPerFrame() Returns the number of perforations per frame on the film stock for this film descriptor.
int	hashCode() Returns a hash code value for this interchange object.
void	setFilmAspectRatio(Rational aspectRatio) Sets the image aspect ratio of this film descriptor, which specifies the ratio between the horizontal size of the frame image and the vertical size of the frame image.
void	setFilmBatchNumber(String filmBatchNumber) Sets the film batch number for this film descriptor.
void	setFilmFormat(FilmType filmFormat) Sets the film format for this film descriptor, according to its film type.
void	setFilmGaugeFormat(String filmGuageFormat) Sets the film gauge format of this film descriptor.
void	setFilmManufacturer(String fileManufacturer) Sets the film manufacturer property of this film descriptor, which is a string to display to end users, indicating the manufacturer of the film.
void	setFilmModel(String filmModel) Sets the film model property of the film descriptor, which is a string to display to end users indicating the manufacturerÕs brand designation for the film, such as "5247".
void	setFrameRate(Integer rate) Set the frame rate for this film descriptor, which specifies the frame rate of the film measured in frames per second.
void	setPerforationsPerFrame(Byte perforationsPerFrame) Set the number of perforations per frame on the film stock for this film descriptor.
void	setPropertiesFromInterface(FilmDescriptor castFrom)

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

appendLocator, appendSubDescriptor, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAt, 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, wait, wait, wait

Methods inherited from interface tv.amwa.maj.iface.EssenceDescriptor

appendLocator, appendSubDescriptor, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAt

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

FILMDESCRIPTOR_TAG

public static final String FILMDESCRIPTOR_TAG

See Also:

Constant Field Values

Constructor Detail

FilmDescriptor

public FilmDescriptor()

Creates and initializes a film descriptor that describes film media.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(FilmDescriptor castFrom)

See Also:

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

getFilmAspectRatio

@AAFProperty(uuid1=68157699,
             uuid2=515,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="FilmAspectRatio",
             typeName="Rational",
             optional=true,
             uniqueIdentifier=false,
             pid=14596)
public Rational getFilmAspectRatio()
                            throws PropertyNotPresentException

Description copied from interface: FilmDescriptor

Returns the image aspect ratio of this film descriptor, which specifies the ratio between the horizontal size of the frame image and the vertical size of the frame image. This is an optional property.

Specified by:

getFilmAspectRatio in interface FilmDescriptor

Returns:

Image aspect ration of the film descriptor.

Throws:

PropertyNotPresentException - The optional image aspect ratio for this film descriptor is not present.

setFilmAspectRatio

public void setFilmAspectRatio(Rational aspectRatio)

Description copied from interface: FilmDescriptor

Sets the image aspect ratio of this film descriptor, which specifies the ratio between the horizontal size of the frame image and the vertical size of the frame image. Set this optional property to null to omit it.

Specified by:

setFilmAspectRatio in interface FilmDescriptor

Parameters:

aspectRatio - Image aspect ratio to set for film descriptor.

getFilmFormat

@AAFProperty(uuid1=68157699,
             uuid2=264,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="FilmFormat",
             typeName="FilmType",
             optional=true,
             uniqueIdentifier=false,
             pid=14593)
public FilmType getFilmFormat()
                       throws PropertyNotPresentException

Description copied from interface: FilmDescriptor

Returns the film format of this film descriptor, according to its film type.

Typical values include:

• FilmType.Ft35MM
• FilmType.Ft16MM
• FilmType.Ft65MM

Specified by:

getFilmFormat in interface FilmDescriptor

Returns:

Film format of the film descriptor.

Throws:

PropertyNotPresentException - The optional film format property is not present for this film descriptor.

setFilmFormat

public void setFilmFormat(FilmType filmFormat)

Description copied from interface: FilmDescriptor

Sets the film format for this film descriptor, according to its film type. Set this optional property to null to omit it.

Typical values include:

• FilmType.Ft35MM
• FilmType.Ft16MM
• FilmType.Ft65MM

Specified by:

setFilmFormat in interface FilmDescriptor

Parameters:

filmFormat - Film format to set for this film descriptor.

getFilmManufacturer

@AAFProperty(uuid1=68157699,
             uuid2=262,
             uuid3=256,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="Manufacturer",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=14597)
public String getFilmManufacturer()
                           throws PropertyNotPresentException

Description copied from interface: FilmDescriptor

Returns the film manufacturer associated with this film descriptor which is a string to display to end users, indicating the manufacturer of the film. This is an optional property.

Specified by:

getFilmManufacturer in interface FilmDescriptor

Returns:

Film manufacturer of this film descriptor.

Throws:

PropertyNotPresentException - The optional film manufacturer property is not present for this film descriptor.

setFilmManufacturer

public void setFilmManufacturer(String fileManufacturer)

Description copied from interface: FilmDescriptor

Sets the film manufacturer property of this film descriptor, which is a string to display to end users, indicating the manufacturer of the film. Set this optional property to null to omit it.

Specified by:

setFilmManufacturer in interface FilmDescriptor

Parameters:

fileManufacturer - Film manufacturer of the described film.

getFilmModel

@AAFProperty(uuid1=68157699,
             uuid2=261,
             uuid3=256,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="Model",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=14598)
public String getFilmModel()
                    throws PropertyNotPresentException

Description copied from interface: FilmDescriptor

Returns the film model associated with this film descriptor, which is a string to display to end users indicating the manufacturerÕs brand designation for the film, such as "5247". This is an optional property.

Specified by:

getFilmModel in interface FilmDescriptor

Returns:

Film model associated with this film descriptor.

Throws:

PropertyNotPresentException - The optional film model property is not present for this film descriptor.

setFilmModel

public void setFilmModel(String filmModel)

Description copied from interface: FilmDescriptor

Sets the film model property of the film descriptor, which is a string to display to end users indicating the manufacturerÕs brand designation for the film, such as "5247". Set this optional property to null to omit it.

Specified by:

setFilmModel in interface FilmDescriptor

Parameters:

filmModel - Film model to set for this film descriptor.

getFrameRate

@AAFProperty(uuid1=67176450,
             uuid2=768,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="FrameRate",
             typeName="UInt32",
             optional=true,
             uniqueIdentifier=false,
             pid=14594)
public int getFrameRate()
                 throws PropertyNotPresentException

Description copied from interface: FilmDescriptor

Returns the frame rate of this film descriptor, which specifies the frame rate of the film measured in frames per second. This is an optional property.

Specified by:

getFrameRate in interface FilmDescriptor

Returns:

Frame rate of the film descriptor.

Throws:

PropertyNotPresentException - The optional frame rate property is not present for this film descriptor.

setFrameRate

public void setFrameRate(Integer rate)
                  throws IllegalArgumentException

Description copied from interface: FilmDescriptor

Set the frame rate for this film descriptor, which specifies the frame rate of the film measured in frames per second. Set this optional property to null to omit it.

Specified by:

setFrameRate in interface FilmDescriptor

Parameters:

rate - Frame rate to set for this film descriptor.

Throws:

IllegalArgumentException - The given frame rate is negative.

getPerfortionsPerFrame

@AAFProperty(uuid1=68157699,
             uuid2=259,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="PerforationsPerFrame",
             typeName="UInt8",
             optional=true,
             uniqueIdentifier=false,
             pid=14595)
public byte getPerfortionsPerFrame()
                            throws PropertyNotPresentException

Description copied from interface: FilmDescriptor

Returns the number of perforations per frame on the film stock for this film descriptor. This is an optional property.

Specified by:

getPerfortionsPerFrame in interface FilmDescriptor

Returns:

Number of perforations per frame for this film descriptor.

Throws:

PropertyNotPresentException - The optional perforations per frame property is not present for this film descriptor.

setPerforationsPerFrame

public void setPerforationsPerFrame(Byte perforationsPerFrame)
                             throws IllegalArgumentException

Description copied from interface: FilmDescriptor

Set the number of perforations per frame on the film stock for this film descriptor. Set this optional property to null to omit it.

Specified by:

setPerforationsPerFrame in interface FilmDescriptor

Parameters:

perforationsPerFrame - Perforations per frame for the film descriptor.

Throws:

IllegalArgumentException

getFilmBatchNumber

@AAFProperty(uuid1=68157699,
             uuid2=263,
             uuid3=256,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="FilmBatchNumber",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=14600)
public String getFilmBatchNumber()
                          throws PropertyNotPresentException

Description copied from interface: FilmDescriptor

Returns the film batch number for this film descriptor. This is an optional property.

Specified by:

getFilmBatchNumber in interface FilmDescriptor

Returns:

Film batch number for this film descriptor.

Throws:

PropertyNotPresentException - The optional film batch number is not present for this film descriptor.

setFilmBatchNumber

public void setFilmBatchNumber(String filmBatchNumber)

Description copied from interface: FilmDescriptor

Sets the film batch number for this film descriptor. Set this optional property to null to omit it.

Specified by:

setFilmBatchNumber in interface FilmDescriptor

Parameters:

filmBatchNumber - Film batch number for this film descriptor.

getFilmGaugeFormat

@AAFProperty(uuid1=68157699,
             uuid2=260,
             uuid3=256,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="FilmGaugeFormat",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=14599)
public String getFilmGaugeFormat()
                          throws PropertyNotPresentException

Description copied from interface: FilmDescriptor

Returns the film gauge format of this film descriptor. This is an optional property.

Specified by:

getFilmGaugeFormat in interface FilmDescriptor

Returns:

Film gauge format if this film descriptor.

Throws:

PropertyNotPresentException - This optional film gauge property is not present for this film descriptor.

setFilmGaugeFormat

public void setFilmGaugeFormat(String filmGuageFormat)

Description copied from interface: FilmDescriptor

Sets the film gauge format of this film descriptor. Set this optional property to null to omit it.

Specified by:

setFilmGaugeFormat in interface FilmDescriptor

Parameters:

filmGuageFormat - Film gauge format if this film descriptor.

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 EssenceDescriptor

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 EssenceDescriptor

Returns:

Hash code value for this interchange object.

See Also:

Object.hashCode()

clone

public FilmDescriptor 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 EssenceDescriptor

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 EssenceDescriptor

Parameters:

parent - XML parent element to append child nodes to.