org.ocap.hn.transformation

Class TransformationManager

java.lang.Object

org.ocap.hn.transformation.TransformationManager

public abstract class TransformationManager
extends Object

This class is a singleton manager that can be used to get transformation capabilities of the Host device and to manage the content item transformation configuration. Transformation capabilities indicate the transformations from input content format to output content format that the device supports.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransformationManager() Constructor protected from erroneous application access.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addTransformationListener(TransformationListener listener) Adds a TransformationListener to receive callbacks from the TransformationManager.
abstract Transformation[]	getDefaultTransformations() Returns the currently-set default transformation.
static TransformationManager	getInstance() Gets an instance of the TransformationManager.
abstract Transformation[]	getSupportedTransformations() Gets all of the transformation permutations the Host device supports.
abstract Transformation[]	getTransformations(ContentItem item) Returns the applied transformations for the content item.
abstract void	removeTransformationListener(TransformationListener listener) Removes the specified TransformationListener.
abstract Transformation[]	setDefaultTransformations(Transformation[] transformations) Sets the default transformations.
abstract void	setTransformations(ContentItem[] items) Applies the default transformations for a set of content items.
abstract void	setTransformations(ContentItem[] items, Transformation[] transformations) Applies specific transformations for a set of content items.
abstract void	setTransformations(Transformation[] transformations) Applies the transformations to all existing local content items that represent network operator content.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransformationManager

protected TransformationManager()

Constructor protected from erroneous application access.

Method Detail

getInstance

public static TransformationManager getInstance()

Gets an instance of the TransformationManager.

Throws:

SecurityException - if the calling application has not been granted HomeNetPermission("contentmanagement").

addTransformationListener

public abstract void addTransformationListener(TransformationListener listener)

Adds a TransformationListener to receive callbacks from the TransformationManager. The TransformationListener will be notified whenever transformations are applied for the ContentItem. Subsequent calls to register the same listener will be ignored.

Parameters:

listener - The listener that will receive the callbacks

Throws:

IllegalArgumentException - if the listener parameter is null.

removeTransformationListener

public abstract void removeTransformationListener(TransformationListener listener)

Removes the specified TransformationListener. If the listener specified is not registered or is null, then this method has no effect

Parameters:

listener - The listener to remove

getSupportedTransformations

public abstract Transformation[] getSupportedTransformations()

Gets all of the transformation permutations the Host device supports. See [OC-BUNDLE] for additional mapping of this method.

Returns:

Device supported transformations. If the device does not support transformations an empty array is returned.

setDefaultTransformations

public abstract Transformation[] setDefaultTransformations(Transformation[] transformations)

Sets the default transformations. Default transformations will be applied to newly-created ContentItems only and certain calls to TransformationManager. A call to setDefaultTransformation over-rides any previously-set default transformations and passing an empty array disables any previously-set default transformations. See [OC-BUNDLE] for additional mapping of this method.

Parameters:

transformations - The new default transformations.

Throws:

IllegalArgumentException - if the transformations parameter is null.

getDefaultTransformations

public abstract Transformation[] getDefaultTransformations()

Returns the currently-set default transformation.

getTransformations

public abstract Transformation[] getTransformations(ContentItem item)

Returns the applied transformations for the content item.

Parameters:

item - The content item.

Throws:

IllegalArgumentException - if the item parameter is null.

setTransformations

public abstract void setTransformations(Transformation[] transformations)

Applies the transformations to all existing local content items that represent network operator content. A call to this method will remove any existing transformations before setting the transformations. See [OC-BUNDLE] for additional mapping of this method.

Parameters:

transformations - The array of transformations to be applied.

Throws:

IllegalArgumentException - if the transformations parameter is null.

setTransformations

public abstract void setTransformations(ContentItem[] items)

Applies the default transformations for a set of content items. Configures metadata indicating content transformation support for each ContentItem in the items array parameter. If a content item in the array parameter is not local or does not represent MSO local content it is skipped without change or notification. A call to this method will remove any existing transformations before setting the transformations. See [OC-BUNDLE] for additional mapping of this method.

Parameters:

items - The array of content items the transformation metadata will be configured in.

Throws:

IllegalArgumentException - if the parameter is null or empty.

setTransformations

public abstract void setTransformations(ContentItem[] items,
                      Transformation[] transformations)

Applies specific transformations for a set of content items. Configures metadata indicating content transformation support that matches any of the transformations in the transformations array parameter for each ContentItem in the items array parameter. If a content item in the array parameter is not local or does not represent MSO local content it is skipped without change or notification. A call to this method will remove any existing transformations before setting the transformations. See [OC-BUNDLE] for additional mapping of this method.

Parameters:

items - The array of content items the transformation metadata will be configured in.

transformations - The array of transformations to apply.

Throws:

IllegalArgumentException - if items parameter is null or empty or the transformations parameter is null.