org.alembik.util
Class OMAUtils

java.lang.Object
  org.alembik.util.OMAUtils

Direct Known Subclasses:

TranscodingUtils

public class OMAUtils
extends java.lang.Object

The class providing utility methods manipulating the classes generated from the OMA-STI schema file.

Since:

1.0-beta5

Field Summary

static java.lang.String	CHANNEL_MONO The value defining the mono channel for an audio.
static java.lang.String	CHANNEL_STEREO The value defining the stereo channel for an audio.
static java.lang.String	COLOR_SCHEME_PALETTE_COLOR The value defining true color scheme; if chosen the Image.ColorScheme's depth will be the preferred number of colors in the image.
static java.lang.String	COLOR_SCHEME_PALETTE_GREY The value defining true color scheme; if chosen the Image.ColorScheme's depth will be the preferred number of colors in a grey scale for the image.
static java.lang.String	COLOR_SCHEME_TRUE The value defining true color scheme; if chosen the Image.ColorScheme's depth will be the number of bits in a color sample within a pixel.
static java.lang.String	RESIZE_ASPECT_RATIO The value defining the aspect ratio resize directive.
static java.lang.String	RESIZE_CROP The value defining the crop resize directive.
static java.lang.String	RESIZE_STRETCH The value defining the stretch resize directive.

Constructor Summary

OMAUtils()

Method Summary

static void	addReturnResult(JobResult result, ResultCode code, java.lang.String message) Creates a new return result instance of the desired code and the description text and sets it as a secondary return result of the given job result.
static void	addReturnResult(TranscodingResponse response, ResultCode code, java.lang.String message) Creates a new return result instance of the desired code and the description text and sets it as a secondary return result of the given transcoding response.
static Property	createProperty(java.lang.String name, java.lang.String value) Creates a new property instance of the specified name and value.
static ReturnResult	createReturnResult(ResultCode code, java.lang.String message) Creates a new return result instance of the desired code and the description text.
static Property	findProperty(Properties properties, java.lang.String name) Returns a property object of the specified name from the given properties holder, if such exists.
static Transformation	findTransformation(Media media, java.lang.String name) Returns a transformation of the specified type from the given media instance, if such exists.
static Properties	getAttributeProperties(Transformation transformation) Returns the attributes holder of the given transformation.
static Properties	getExtensionProperties(JobResult.Output output) Returns "extension data" properties holder of the given job result's output.
static Properties	getExtensionProperties(JobResult result) Returns "extension data" properties holder of the given job result.
static Properties	getExtensionProperties(Media media) Returns "extension data" properties holder of the given media object.
static Properties	getExtensionProperties(MediaProperties mediaProperties) Returns "extension data" properties holder of the given media properties.
static Properties	getExtensionProperties(TranscodingJob.Source source) Returns "extension data" properties holder of the given transcoding job's source.
static Properties	getExtensionProperties(TranscodingJob.Target target) Returns "extension data" properties holder of the given transcoding job's target.
static Properties	getExtensionProperties(TranscodingJob job) Returns "extension data" properties holder of the given transcoding job.
static Properties	getExtensionProperties(TranscodingParams profile) Returns "extension data" properties holder of the given transcoding profile.
static Properties	getExtensionProperties(TranscodingRequest request) Returns "extension data" properties holder of the given transcoding request.
static Media	getMedia(TranscodingParams profile) Returns a media object assigned to the given transcoding profile.
static MediaProperties	getOutputMediaProperties(JobResult result) Returns the media properties instance of the given job result.
static java.util.Map<java.lang.String,java.lang.String>	getPropertiesMap(Properties properties) Creates a map of property's {name, value} entries from the given properties holder.
static java.util.Map<java.lang.String,java.lang.String>	getPropertiesMap(Properties properties, java.lang.String prefix) Creates a map of property's {name, value} entries from the given properties holder.
static java.lang.String	getPropertyValue(Properties properties, java.lang.String name) Returns the value of a property of the given name.
static ReturnResults	getReturnResults(JobResult result) Returns the holder object of secondary transcoding results of the given job result object.
static ReturnResults	getReturnResults(TranscodingResponse response) Returns the holder object of secondary transcoding results of the given response object.
static java.lang.Long	getSizeLimit(TranscodingJob job) Returns the size limit specified for a transcoded file of the given transcoding job.
static Transformations	getTransformations(Media media) Returns the transformations holder from the given media object.
static Transformation	removeTransformation(Media media, java.lang.String name) Removes a transformation of the specified type from the given media instance, if such exists.
static Transformation	removeTransformation(TranscodingJob job, java.lang.String name) Removes a transformation of the specified type from the given transcoding job, if such exists.
static void	setMedia(TranscodingParams profile, Media media) Assigns the media type to the given transcoding profile.
static Property	setProperty(Properties properties, java.lang.String name, java.lang.String value) Adds a property of the given name and value to the given properties holder.
static void	setResizeDirective(Media media, java.lang.String directive) Sets the desired resize directive for the media instance.
static Transformation	setTransformation(Media media, java.lang.String name) Adds a transformation of the desired type to the given media instance, if such does not exist.

Methods inherited from class java.lang.Object

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

Field Detail

COLOR_SCHEME_TRUE

public static final java.lang.String COLOR_SCHEME_TRUE

The value defining true color scheme; if chosen the Image.ColorScheme's depth will be the number of bits in a color sample within a pixel.

See Also:

Image.ColorScheme.setScheme(String), Constant Field Values

COLOR_SCHEME_PALETTE_COLOR

public static final java.lang.String COLOR_SCHEME_PALETTE_COLOR

The value defining true color scheme; if chosen the Image.ColorScheme's depth will be the preferred number of colors in the image.

See Also:

Image.ColorScheme.setScheme(String), Constant Field Values

COLOR_SCHEME_PALETTE_GREY

public static final java.lang.String COLOR_SCHEME_PALETTE_GREY

The value defining true color scheme; if chosen the Image.ColorScheme's depth will be the preferred number of colors in a grey scale for the image.

See Also:

Image.ColorScheme.setScheme(String), Constant Field Values

RESIZE_ASPECT_RATIO

public static final java.lang.String RESIZE_ASPECT_RATIO

The value defining the aspect ratio resize directive.

See Also:

setResizeDirective(Media, String), Image.setResizeDirective(String), Video.VideoVisual.setResizeDirective(String), Constant Field Values

RESIZE_CROP

public static final java.lang.String RESIZE_CROP

The value defining the crop resize directive.

See Also:

setResizeDirective(Media, String), Image.setResizeDirective(String), Video.VideoVisual.setResizeDirective(String), Constant Field Values

RESIZE_STRETCH

public static final java.lang.String RESIZE_STRETCH

The value defining the stretch resize directive.

See Also:

setResizeDirective(Media, String), Image.setResizeDirective(String), Video.VideoVisual.setResizeDirective(String), Constant Field Values

CHANNEL_MONO

public static final java.lang.String CHANNEL_MONO

The value defining the mono channel for an audio.

See Also:

Audio.setChannels(String), Video.VideoAudio.setChannels(String), Constant Field Values

CHANNEL_STEREO

public static final java.lang.String CHANNEL_STEREO

The value defining the stereo channel for an audio.

See Also:

Audio.setChannels(String), Video.VideoAudio.setChannels(String), Constant Field Values

Constructor Detail

OMAUtils

public OMAUtils()

Method Detail

getMedia

public static Media getMedia(TranscodingParams profile)

Returns a media object assigned to the given transcoding profile. The media class identifies the desired type of a transcoded content/file and the object itself carries the transcoding parameters and transformations.

Parameters:

profile - profile of a transcoding job

Returns:

media instance if found; otherwise null

See Also:

Image, Audio, Video, Text, setMedia(TranscodingParams, Media), TranscodingJob.Target.getTranscodingParams()

setMedia

public static void setMedia(TranscodingParams profile,
                            Media media)

Assigns the media type to the given transcoding profile.

Parameters:

profile - profile of a transcoding job

media - media instance to be set

See Also:

Image, Audio, Video, Text, getMedia(TranscodingParams), TranscodingJob.Target.getTranscodingParams()

getTransformations

public static Transformations getTransformations(Media media)

Returns the transformations holder from the given media object. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

media - media instance

Returns:

transformations holder

See Also:

Media.getTransformations()

getReturnResults

public static ReturnResults getReturnResults(TranscodingResponse response)

Returns the holder object of secondary transcoding results of the given response object. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

response - response to a transcoding request

Returns:

return results holder

See Also:

TranscodingResponse.getAdditionalReturnResults()

getReturnResults

public static ReturnResults getReturnResults(JobResult result)

Returns the holder object of secondary transcoding results of the given job result object. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

result - job result of a transcoding job

Returns:

return results holder

See Also:

JobResult.getAdditionalReturnResults()

createReturnResult

public static ReturnResult createReturnResult(ResultCode code,
                                              java.lang.String message)

Creates a new return result instance of the desired code and the description text. The object is used to provide the information on a transcoding process result.

Parameters:

code - return result code

message - return result description

Returns:

return result object

See Also:

TranscodingResponse.setMainReturnResult(ReturnResult), JobResult.setMainReturnResult(ReturnResult), getReturnResults(TranscodingResponse), getReturnResults(JobResult)

addReturnResult

public static void addReturnResult(TranscodingResponse response,
                                   ResultCode code,
                                   java.lang.String message)

Creates a new return result instance of the desired code and the description text and sets it as a secondary return result of the given transcoding response.

Parameters:

response - transcoding response

code - return result code

message - return result description

See Also:

createReturnResult(ResultCode, String), getReturnResults(TranscodingResponse)

addReturnResult

public static void addReturnResult(JobResult result,
                                   ResultCode code,
                                   java.lang.String message)

Creates a new return result instance of the desired code and the description text and sets it as a secondary return result of the given job result.

Parameters:

result - job result

code - return result code

message - return result description

See Also:

createReturnResult(ResultCode, String), getReturnResults(JobResult)

getExtensionProperties

public static Properties getExtensionProperties(TranscodingRequest request)

Returns "extension data" properties holder of the given transcoding request. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

request - transcoding request

Returns:

extension data properties

See Also:

TranscodingRequest.getExtensionData()

getExtensionProperties

public static Properties getExtensionProperties(TranscodingJob job)

Returns "extension data" properties holder of the given transcoding job. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

job - transcoding job

Returns:

extension data properties

See Also:

Job.getExtensionData()

getExtensionProperties

public static Properties getExtensionProperties(JobResult result)

Returns "extension data" properties holder of the given job result. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

result - job result

Returns:

extension data properties

See Also:

Job.getExtensionData()

getExtensionProperties

public static Properties getExtensionProperties(JobResult.Output output)

Returns "extension data" properties holder of the given job result's output. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

output - job result's output

Returns:

extension data properties

See Also:

JobResult.Output.getExtensionData()

getExtensionProperties

public static Properties getExtensionProperties(TranscodingJob.Source source)

Returns "extension data" properties holder of the given transcoding job's source. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

source - transcoding job's source

Returns:

extension data properties

See Also:

TranscodingJob.Source.getExtensionData()

getExtensionProperties

public static Properties getExtensionProperties(TranscodingJob.Target target)

Returns "extension data" properties holder of the given transcoding job's target. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

target - transcoding job's target

Returns:

extension data properties

See Also:

TranscodingJob.Target.getExtensionData()

getExtensionProperties

public static Properties getExtensionProperties(TranscodingParams profile)

Returns "extension data" properties holder of the given transcoding profile. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

profile - transcoding profile

Returns:

extension data properties

See Also:

TranscodingParams.getExtensionData()

getExtensionProperties

public static Properties getExtensionProperties(Media media)

Returns "extension data" properties holder of the given media object. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

media - media instance

Returns:

extension data properties

See Also:

Media.getExtensionData()

getExtensionProperties

public static Properties getExtensionProperties(MediaProperties mediaProperties)

Returns "extension data" properties holder of the given media properties. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

mediaProperties - job result's media properties

Returns:

extension data properties

See Also:

MediaProperties.getExtensionData(), getOutputMediaProperties(JobResult)

getOutputMediaProperties

public static MediaProperties getOutputMediaProperties(JobResult result)

Returns the media properties instance of the given job result. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

result - job result

Returns:

media properties object

See Also:

getOutputMediaProperties(JobResult)

getAttributeProperties

public static Properties getAttributeProperties(Transformation transformation)

Returns the attributes holder of the given transformation. If it has not been set before, the method creates and assignes a new (empty) one.

Parameters:

transformation - transcoding transformation

Returns:

transformation attributes

See Also:

Transformation.getAttributes()

getPropertyValue

public static java.lang.String getPropertyValue(Properties properties,
                                                java.lang.String name)

Returns the value of a property of the given name.

Parameters:

properties - properties holder

name - name of the property looked up (case insensitive)

Returns:

value of the property if found; otherwise null

See Also:

Property

createProperty

public static Property createProperty(java.lang.String name,
                                      java.lang.String value)

Creates a new property instance of the specified name and value.

Parameters:

name - desired property name

value - desired property value

Returns:

property instance

setProperty

public static Property setProperty(Properties properties,
                                   java.lang.String name,
                                   java.lang.String value)

Adds a property of the given name and value to the given properties holder. If a property of a given name already exists it only sets its value; otherwise inserts a new property instance.

Parameters:

properties - properites holder

name - desired property name (case insensitive)

value - desired property value

Returns:

inserted or updated property object

See Also:

Properties.getProperty()

findProperty

public static Property findProperty(Properties properties,
                                    java.lang.String name)

Returns a property object of the specified name from the given properties holder, if such exists.

Parameters:

properties - properites holder

name - name of the property to be found (case insensitive)

Returns:

property object if found; otherwise null

See Also:

Properties.getProperty()

getPropertiesMap

public static java.util.Map<java.lang.String,java.lang.String> getPropertiesMap(Properties properties)

Creates a map of property's {name, value} entries from the given properties holder.

Parameters:

properties - properties holder

Returns:

map of properties fields

See Also:

getPropertiesMap(Properties, String), Properties.getProperty()

getPropertiesMap

public static java.util.Map<java.lang.String,java.lang.String> getPropertiesMap(Properties properties,
                                                                                java.lang.String prefix)

Creates a map of property's {name, value} entries from the given properties holder. The map will contain only those properties, whose names start with the given prefix.

Parameters:

properties - properties holder

prefix - desired prefix of the properties names (case insensitive); if null no property will be excluded

Returns:

map of properties fields

See Also:

getPropertiesMap(Properties), Properties.getProperty()

getSizeLimit

public static java.lang.Long getSizeLimit(TranscodingJob job)

Returns the size limit specified for a transcoded file of the given transcoding job. The method inspects limit fields in the objects tree in the following order, returning the first non-null value found:

• TranscodingJob.Target.getApplicationSizeLimit(),
• Media.getSizeLimit(),
• TranscodingParams.getSizeLimit().

Parameters:

job - transcoding job

Returns:

size limit (in bytes) for a trancoded file, if set; otherwise null

findTransformation

public static Transformation findTransformation(Media media,
                                                java.lang.String name)

Returns a transformation of the specified type from the given media instance, if such exists.

Parameters:

media - media object

name - type of the transformation to be found (case insensitive)

Returns:

transformation object if found; otherwise null

See Also:

getTransformations(Media)

setTransformation

public static Transformation setTransformation(Media media,
                                               java.lang.String name)

Adds a transformation of the desired type to the given media instance, if such does not exist.

Parameters:

media - media object

name - transformation type (case insensitive)

Returns:

created or found transformation of the specified type

See Also:

getTransformations(Media)

removeTransformation

public static Transformation removeTransformation(Media media,
                                                  java.lang.String name)

Removes a transformation of the specified type from the given media instance, if such exists.

Parameters:

media - media object

name - type of the transformation to be removed (case insensitive)

Returns:

removed transformation, if found; otherwise null

See Also:

getTransformations(Media)

removeTransformation

public static Transformation removeTransformation(TranscodingJob job,
                                                  java.lang.String name)

Removes a transformation of the specified type from the given transcoding job, if such exists.

Parameters:

job - transcoding job

name - type of the transformation to be removed (case insensitive)

Returns:

removed transformation, if found; otherwise null

See Also:

getTransformations(Media), getMedia(TranscodingParams)

setResizeDirective

public static void setResizeDirective(Media media,
                                      java.lang.String directive)

Sets the desired resize directive for the media instance. The acceptable values for the directive argument are:

• RESIZE_ASPECT_RATIO
• RESIZE_CROP
• RESIZE_STRETCH

Parameters:

media - media object

directive - desired resize directive

See Also:

Image.setResizeDirective(String), Video.VideoVisual.setResizeDirective(String)