Package org.opencastproject.composer.api

Class EncodingProfileImpl

java.lang.Object

org.opencastproject.composer.api.EncodingProfileImpl

All Implemented Interfaces:

EncodingProfile

public class EncodingProfileImpl
extends Object
implements EncodingProfile

Default implementation for encoding profiles.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EncodingProfileImpl.Extension	An extension property.

Nested classes/interfaces inherited from interface org.opencastproject.composer.api.EncodingProfile

EncodingProfile.MediaType

Field Summary

Fields

Modifier and Type	Field	Description
protected EncodingProfile.MediaType	applicableType	The track type that this profile may be applied to
protected List<EncodingProfileImpl.Extension>	extensions	Installation-specific properties
protected String	identifier	The profile identifier
protected Float	jobLoad
protected String	mimeType	Mime type
protected String	name	Format description
protected EncodingProfile.MediaType	outputType	Format type
protected Object	source
protected HashMap<String,String>	suffixes

Constructor Summary

Constructors

Constructor	Description
EncodingProfileImpl()
EncodingProfileImpl(String identifier, String name, Object source)	Private, since the profile should be created using the static factory method.

Method Summary

Modifier and Type	Method	Description
void	addExtension(String key, String value)	Adds the given key-value pair to the extended configuration space of this media profile.
boolean	equals(Object obj)
EncodingProfile.MediaType	getApplicableMediaType()	Returns the media format that can be used with this encoding profile.
String	getExtension(String key)	Returns the extension specified by key or null if no such key was defined.
Map<String,String>	getExtensions()	Returns a map containing the additional properties or an empty map if no additional properties were found.
String	getIdentifier()	Returns the unique format identifier.
float	getJobLoad()	Returns an estimate of the load a single job with this profile causes.
String	getMimeType()	Return the mimetype as string
String	getName()	Returns the encoding format's name.
EncodingProfile.MediaType	getOutputType()	Returns the encoding format's media type, which is either video (plus audio) or audio only.
Object	getSource()	Returns the source object that provided this encoding profile
String	getSuffix()	Returns a suffix of the files.
String	getSuffix(String tag)	Returns a suffix of the files for a certain tag.
List<String>	getTags()	Returns a list of the tags for output files used in this request
boolean	hasExtensions()	Returns true if additional properties have been specified.
int	hashCode()
boolean	isApplicableTo(EncodingProfile.MediaType type)	Returns true if the profile is applicable for the given track type.
String	removeExtension(String key)	Removes the specified property from the extended configuation space and returns either the property value or null if no property was found.
void	setApplicableType(EncodingProfile.MediaType applicableType)	Sets the applicable type.
void	setExtensions(Map<String,String> extension)	Sets the extension properties for that profile.
void	setIdentifier(String id)	Sets the identifier
void	setJobLoad(Float jobLoad)	Sets the job load for this encoding profile
void	setMimeType(String mimeType)	sets the mimetype of the output if applicable
void	setName(String name)	Sets the profile name
void	setOutputType(EncodingProfile.MediaType type)	Sets the output type.
void	setSuffix(String suffix)	Sets the suffix for encoded file names.
void	setSuffix(String tag, String suffix)	Sets the suffix for encoded file names.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

identifier

protected String identifier

The profile identifier

name

protected String name

Format description

source

protected Object source

outputType

protected EncodingProfile.MediaType outputType

Format type

mimeType

protected String mimeType

Mime type

applicableType

protected EncodingProfile.MediaType applicableType

The track type that this profile may be applied to

extensions

protected List<EncodingProfileImpl.Extension> extensions

Installation-specific properties

suffixes

protected HashMap<String,String> suffixes

jobLoad

protected Float jobLoad

Constructor Details

EncodingProfileImpl

public EncodingProfileImpl(String identifier,
 String name,
 Object source)

Private, since the profile should be created using the static factory method.

Parameters:

identifier - the profile identifier

name - the profile name

EncodingProfileImpl

public EncodingProfileImpl()

Method Details

getIdentifier

public String getIdentifier()

Returns the unique format identifier.

Specified by:

getIdentifier in interface EncodingProfile

Returns:

the format identifier

See Also:

• EncodingProfile.getIdentifier()

setIdentifier

public void setIdentifier(String id)

Sets the identifier

Parameters:

id - the identifier

getName

public String getName()

Returns the encoding format's name.

Specified by:

getName in interface EncodingProfile

Returns:

the format name

See Also:

• EncodingProfile.getName()

setName

public void setName(String name)

Sets the profile name

Parameters:

name - the profile name

getSource

public Object getSource()

Returns the source object that provided this encoding profile

Specified by:

getSource in interface EncodingProfile

Returns:

the source object that provided this profile

See Also:

• EncodingProfile.getSource()

getOutputType

public EncodingProfile.MediaType getOutputType()

Returns the encoding format's media type, which is either video (plus audio) or audio only.

Specified by:

getOutputType in interface EncodingProfile

Returns:

the format type

See Also:

• EncodingProfile.getOutputType()

setOutputType

public void setOutputType(EncodingProfile.MediaType type)

Sets the output type.

Parameters:

type - the output type

getSuffix

public String getSuffix()

Returns a suffix of the files. First tag found used if tags are used but not provided in the request

Specified by:

getSuffix in interface EncodingProfile

Returns:

the suffix

See Also:

• EncodingProfile.getSuffix()

setSuffix

public void setSuffix(String suffix)

Sets the suffix for encoded file names.

Parameters:

suffix - the file suffix

setSuffix

public void setSuffix(String tag,
 String suffix)

Sets the suffix for encoded file names.

Parameters:

suffix - the file suffix

getMimeType

public String getMimeType()

Return the mimetype as string

Specified by:

getMimeType in interface EncodingProfile

See Also:

• EncodingProfile.getMimeType()

setMimeType

public void setMimeType(String mimeType)

sets the mimetype of the output if applicable

Specified by:

setMimeType in interface EncodingProfile

Parameters:

mimeType -

getApplicableMediaType

public EncodingProfile.MediaType getApplicableMediaType()

Returns the media format that can be used with this encoding profile.

Specified by:

getApplicableMediaType in interface EncodingProfile

Returns:

the applicable input format

See Also:

• EncodingProfile.getApplicableMediaType()

setApplicableType

public void setApplicableType(EncodingProfile.MediaType applicableType)

Sets the applicable type.

Parameters:

applicableType - the applicableType to set

isApplicableTo

public boolean isApplicableTo(EncodingProfile.MediaType type)

Returns true if the profile is applicable for the given track type.

Specified by:

isApplicableTo in interface EncodingProfile

Parameters:

type - the track type

Returns:

true if the profile is applicable

See Also:

• EncodingProfile.isApplicableTo(org.opencastproject.composer.api.EncodingProfile.MediaType)

getExtension

public String getExtension(String key)

Returns the extension specified by key or null if no such key was defined.

Note that key must not contain the media format prefix, so if the configured entry was mediaformat.format.xyz.test, then the key to access the value must simply be test.

Specified by:

getExtension in interface EncodingProfile

Parameters:

key - the extension key

Returns:

the value or null

See Also:

• EncodingProfile.getExtension(java.lang.String)

addExtension

public void addExtension(String key,
 String value)

Adds the given key-value pair to the extended configuration space of this media profile.

Parameters:

key - the property key

value - the property value

getExtensions

public Map<String,String> getExtensions()

Returns a map containing the additional properties or an empty map if no additional properties were found.

Specified by:

getExtensions in interface EncodingProfile

Returns:

the additional properties

See Also:

• EncodingProfile.getExtensions()

setExtensions

public void setExtensions(Map<String,String> extension)

Sets the extension properties for that profile. These properties may be intepreted by the encoder engine.

Parameters:

extension - the extension properties

removeExtension

public String removeExtension(String key)

Removes the specified property from the extended configuation space and returns either the property value or null if no property was found.

Parameters:

key - the property key

Returns:

the property value or null

hasExtensions

public boolean hasExtensions()

Returns true if additional properties have been specified.

Specified by:

hasExtensions in interface EncodingProfile

Returns:

true if there are additional properties

See Also:

• EncodingProfile.hasExtensions()

getJobLoad

public float getJobLoad()

Returns an estimate of the load a single job with this profile causes. This should be roughly equal to the number of processor cores used at runtime.

Specified by:

getJobLoad in interface EncodingProfile

Returns:

the load a single job with this profile causes

See Also:

• EncodingProfile.getJobLoad()

setJobLoad

public void setJobLoad(Float jobLoad)

Sets the job load for this encoding profile

Parameters:

jobLoad - the load caused by one instance of this encoding profile running

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

getSuffix

public String getSuffix(String tag)

Description copied from interface: EncodingProfile

Returns a suffix of the files for a certain tag.

Specified by:

getSuffix in interface EncodingProfile

Parameters:

tag - a tag that describes the aoutput file

Returns:

the suffix

getTags

public List<String> getTags()

Description copied from interface: EncodingProfile

Returns a list of the tags for output files used in this request

Specified by:

getTags in interface EncodingProfile

Returns:

a list of the used tags