org.mmbase.applications.media.builders

Class MediaFragments

java.lang.Object

org.mmbase.util.functions.FunctionProvider

org.mmbase.module.core.MMTable

org.mmbase.module.core.MMObjectBuilder

org.mmbase.applications.media.builders.MediaFragments

All Implemented Interfaces:

EventListener, NodeEventListener, RelationEventListener

public class MediaFragments
extends MMObjectBuilder

The MediaFragment builder describes a piece of media. This can be audio, or video. A media fragment contains a title, description, and more information about the media fragment. A media fragment will have relations with mediasources which are the actual files in different formats (mp3, real, etc.) The classification, and replace methods are added for backwards compatibility.

Since:

MMBase-1.7

Version:

$Id$

Author:

Rob Vermeulen (VPRO), Michiel Meeuwissen

Field Summary

Fields

Modifier and Type	Field and Description
static Parameter[]	AVAILABLE_PARAMETERS
static Parameter[]	DURATION_PARAMETERS
static Parameter[]	FILTEREDURLS_PARAMETERS
static Parameter[]	FORMAT_PARAMETERS
static String	FUNCTION_AVAILABLE
static String	FUNCTION_DURATION
static String	FUNCTION_FILTEREDURLS
static String	FUNCTION_FORMAT
static String	FUNCTION_NUDEURL
static String	FUNCTION_PARENTS
static String	FUNCTION_ROOT
static String	FUNCTION_SUBFRAGMENT
static String	FUNCTION_SUBFRAGMENTS
static String	FUNCTION_URL
static String	FUNCTION_URLS
static Parameter[]	ISSUBFRAGMENT_PARAMETERS
static Parameter[]	NUDEURL_PARAMETERS
static Parameter[]	PARENTS_PARAMETERS
static Parameter[]	ROOT_PARAMETERS
static Parameter[]	SUBFRAGMENT_SPARAMETERS
static Parameter[]	URL_PARAMETERS
static Parameter[]	URLS_PARAMETERS

Fields inherited from class org.mmbase.module.core.MMObjectBuilder

AGE_PARAMETERS, broadCastChanges, DEFAULT_ALINEA, DEFAULT_EOL, description, descriptions, EVENT_TYPE_LOCAL, EVENT_TYPE_REMOTE, FIELD_NUMBER, FIELD_OBJECT_TYPE, FIELD_OWNER, fields, genericBlobCache, getFunctions, GUI_INDICATOR, GUI_PARAMETERS, guiFunction, infoFunction, internalVersion, nodeCache, oType, pluralNames, searchAge, singularNames, SYSTEM_OWNER, TEMPNODE_DEFAULT_SIZE, temporaryNodes, TMP_FIELD_EXISTS, TMP_FIELD_NUMBER, virtual, WRAP_PARAMETERS, wrapFunction

Fields inherited from class org.mmbase.module.core.MMTable

maxNodesFromQuery, mmb, storageConnector, tableName

Fields inherited from class org.mmbase.util.functions.FunctionProvider

functions

Constructor Summary

Constructors

Constructor and Description
MediaFragments()

Method Summary

Modifier and Type	Method and Description
protected boolean	addParentFragment(Stack<MMObjectNode> fragments) Adds a parent fragment to the Stack and returns true, or returns false.
protected long	calculateLength(MMObjectNode node) Calculate the length of a mediafragment
boolean	equals(MMObjectNode o1, MMObjectNode o2) Implements equals for nodes (this is in MMObjectBuilder because you cannot override MMObjectNode)
protected Object	executeFunction(MMObjectNode node, String function, List<?> args) Executes a function on the field of a node, and returns the result.
protected List<URLComposer>	getFilteredURLs(MMObjectNode fragment, Map<String,Object> info, Set<MMObjectNode> cacheExpireObjects)
protected String	getFormat(MMObjectNode fragment, Map<String,Object> info)
String	getGUIIndicator(MMObjectNode node) Will show the title (clickable if possible)
String	getGUIIndicator(String field, MMObjectNode node) What should a GUI display for this node/field combo.
Object	getObjectValue(MMObjectNode node, String field) Like getValue, but without the 'old' code (short_ html_ etc).
Stack<MMObjectNode>	getParentFragments(MMObjectNode fragment) Returns a Stack with all parent fragments.
MMObjectNode	getRootFragment(MMObjectNode fragment) Find the mediafragment of which the given mediafragment is a part.
List<MMObjectNode>	getSources(MMObjectNode fragment) Get all mediasources belonging to this mediafragment (scope should be protected)
protected String	getURL(MMObjectNode fragment, Map<String,Object> info) Retrieves the url of the mediasource that matches best.
protected List<URLComposer>	getURLs(MMObjectNode fragment, Map<String,Object> info, List<URLComposer> urls, Set<MMObjectNode> cacheExpireObjects) Returns a List of all possible (unfiltered) URLComposer's for this Fragment.
boolean	init() Initializes this builder The property 'mmb' needs to be set for the builder before this method can be called.
boolean	isSubFragment(MMObjectNode mediafragment) If a mediafragment is coupled to another mediafragment instead of being directly coupled to mediasources, the mediafragment is a subfragment.
void	removeSources(MMObjectNode fragment) Removes related media sources.
String	replace(PageInfo sp, StringTokenizer command) Replace all for frontend code Replace commands available are GETURL (gets mediafile url for an objectnumber),
boolean	setValue(MMObjectNode node, String fieldname) Provides additional functionality when setting field values.
protected static Map<String,Object>	translateURLArguments(List<?> arguments, Map<String,Object> info) Would something like this be feasible to translate a List to a Map?

Methods inherited from class org.mmbase.module.core.MMObjectBuilder

addEventListener, addField, addLocalObserver, addRemoteObserver, broadcastChanges, checkAddTmpField, clearBlobCache, commit, create, createAlias, createAlias, createIfNotExists, delete, equals, executeFunction, fieldLocalChanged, getAncestors, getBlobCache, getClassName, getConfigFile, getConfigResource, getDataTypeCollector, getDBState, getDBType, getDefaultTeaser, getDefaultUrl, getDescendants, getDescription, getDescription, getDescriptions, getEmptyNode, getField, getFieldNames, getFields, getFields, getFunction, getFunctionParameters, getFunctions, getGUIIndicator, getHTML, getInitParameter, getInitParameters, getInitParameters, getInternalVersion, getList, getLocaleGUIIndicator, getLocaleGUIIndicator, getMachineName, getMaintainer, getNewNode, getNewTmpNode, getNextField, getNextField, getNode, getNode, getNode, getNodeFromCache, getNodeGUIIndicator, getNumber, getObjectType, getParentBuilder, getPluralName, getPluralName, getPluralNames, getRelations_main, getSearchAge, getShort, getShortedByte, getShortedInputStream, getShortedText, getSingularName, getSingularName, getSingularNames, getSmartPath, getTmpNode, getURLEncode, getValue, getVersion, getWAP, getXMLPath, hasField, hashCode, hashCode, hostname_function, insert, insert, isExtensionOf, isNodeCached, isNull, isVirtual, loadInitParameters, newFunctionInstance, nodeLocalChanged, nodeRemoteChanged, notify, notify, preCommit, process, removeEventListener, removeField, removeLocalObserver, removeNode, removeRelations, removeRemoteObserver, removeSyncNodes, safeCache, sendFieldChangeSignal, setDefaults, setDescription, setDescriptions, setFields, setInitParameter, setMaintainer, setPluralNames, setSearchAge, setSingularNames, setUniqueValue, setUniqueValue, setValue, setVersion, setXMLPath, shutdown, testValidData, toString, toString, update, updateFields, wrap

Methods inherited from class org.mmbase.module.core.MMTable

count, count, created, getFullTableName, getMMBase, getNode, getNodes, getNodes, getNodes, getNodeType, getStorageConnector, getTableName, search, searchVector, setMMBase, setTableName, size

Methods inherited from class org.mmbase.util.functions.FunctionProvider

addFunction, createParameters, getFunction, getFunctions, getFunctionValue

Methods inherited from class java.lang.Object

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

Field Detail

FUNCTION_URLS

public static final String FUNCTION_URLS

See Also:

Constant Field Values

FUNCTION_FILTEREDURLS

public static final String FUNCTION_FILTEREDURLS

See Also:

Constant Field Values

FUNCTION_URL

public static final String FUNCTION_URL

See Also:

Constant Field Values

FUNCTION_NUDEURL

public static final String FUNCTION_NUDEURL

See Also:

Constant Field Values

FUNCTION_PARENTS

public static final String FUNCTION_PARENTS

See Also:

Constant Field Values

FUNCTION_ROOT

public static final String FUNCTION_ROOT

See Also:

Constant Field Values

FUNCTION_SUBFRAGMENT

public static final String FUNCTION_SUBFRAGMENT

See Also:

Constant Field Values

FUNCTION_SUBFRAGMENTS

public static final String FUNCTION_SUBFRAGMENTS

See Also:

Constant Field Values

FUNCTION_AVAILABLE

public static final String FUNCTION_AVAILABLE

See Also:

Constant Field Values

FUNCTION_FORMAT

public static final String FUNCTION_FORMAT

See Also:

Constant Field Values

FUNCTION_DURATION

public static final String FUNCTION_DURATION

See Also:

Constant Field Values

URLS_PARAMETERS

public static final Parameter[] URLS_PARAMETERS

FILTEREDURLS_PARAMETERS

public static final Parameter[] FILTEREDURLS_PARAMETERS

URL_PARAMETERS

public static final Parameter[] URL_PARAMETERS

NUDEURL_PARAMETERS

public static final Parameter[] NUDEURL_PARAMETERS

PARENTS_PARAMETERS

public static final Parameter[] PARENTS_PARAMETERS

ROOT_PARAMETERS

public static final Parameter[] ROOT_PARAMETERS

ISSUBFRAGMENT_PARAMETERS

public static final Parameter[] ISSUBFRAGMENT_PARAMETERS

SUBFRAGMENT_SPARAMETERS

public static final Parameter[] SUBFRAGMENT_SPARAMETERS

AVAILABLE_PARAMETERS

public static final Parameter[] AVAILABLE_PARAMETERS

FORMAT_PARAMETERS

public static final Parameter[] FORMAT_PARAMETERS

DURATION_PARAMETERS

public static final Parameter[] DURATION_PARAMETERS

Constructor Detail

MediaFragments

public MediaFragments()

Method Detail

init

public boolean init()

Description copied from class: MMObjectBuilder

Initializes this builder The property 'mmb' needs to be set for the builder before this method can be called. The method retrieves data from the TypeDef builder, or adds data to that builder if the current builder is not yet registered.

Overrides:

init in class MMObjectBuilder

Returns:

true if init was completed, false if uncompleted.

See Also:

MMObjectBuilder.create()

translateURLArguments

protected static Map<String,Object> translateURLArguments(List<?> arguments,
                                                          Map<String,Object> info)

Would something like this be feasible to translate a List to a Map?

executeFunction

protected Object executeFunction(MMObjectNode node,
                                 String function,
                                 List<?> args)

Executes a function on the field of a node, and returns the result. This method is called by the builder's MMObjectBuilder.getValue(org.mmbase.module.core.MMObjectNode, java.lang.String) method. Derived builders should override this method to provide additional functions.

Overrides:

executeFunction in class MMObjectBuilder

See Also:

MMObjectBuilder.executeFunction(org.mmbase.module.core.MMObjectNode, java.lang.String, java.util.List<?>)

calculateLength

protected long calculateLength(MMObjectNode node)

Calculate the length of a mediafragment

Parameters:

node - the mediafragment

Returns:

length in milliseconds

getGUIIndicator

public String getGUIIndicator(MMObjectNode node)

Will show the title (clickable if possible)

Overrides:

getGUIIndicator in class MMObjectBuilder

Parameters:

node - the mediafragment node

Returns:

the title of the mediafragment

getGUIIndicator

public String getGUIIndicator(String field,
                              MMObjectNode node)

Description copied from class: MMObjectBuilder

What should a GUI display for this node/field combo. Default is null (indicating to display the field as is) Override this to display your own choice.

Overrides:

getGUIIndicator in class MMObjectBuilder

Parameters:

field - the name field of the field to display

node - The node to display

Returns:

the display of the node's field as a String, null if not specified

getURLs

protected List<URLComposer> getURLs(MMObjectNode fragment,
                                    Map<String,Object> info,
                                    List<URLComposer> urls,
                                    Set<MMObjectNode> cacheExpireObjects)

Returns a List of all possible (unfiltered) URLComposer's for this Fragment. A list of arguments can be supplied, which is currently unused (but should not be null). It could contain a Map with preferences, or other information about the client.

getFilteredURLs

protected List<URLComposer> getFilteredURLs(MMObjectNode fragment,
                                            Map<String,Object> info,
                                            Set<MMObjectNode> cacheExpireObjects)

getURL

protected String getURL(MMObjectNode fragment,
                        Map<String,Object> info)

Retrieves the url of the mediasource that matches best. (e.g. pnm://www.mmbase.org/music/test.ra)

Parameters:

fragment - the media fragment

info - extra information (i.e. request, wanted bitrate, preferred format)

Returns:

the url of the audio file

getFormat

protected String getFormat(MMObjectNode fragment,
                           Map<String,Object> info)

isSubFragment

public boolean isSubFragment(MMObjectNode mediafragment)

If a mediafragment is coupled to another mediafragment instead of being directly coupled to mediasources, the mediafragment is a subfragment.

Returns:

true if the mediafragment is coupled to another fragment, false otherwise.

addParentFragment

protected boolean addParentFragment(Stack<MMObjectNode> fragments)

Adds a parent fragment to the Stack and returns true, or returns false.

getParentFragments

public Stack<MMObjectNode> getParentFragments(MMObjectNode fragment)

Returns a Stack with all parent fragments. Starts stacking from this, so on top is the mediafragment with the sources, and on the bottom is the fragment itself.

getRootFragment

public MMObjectNode getRootFragment(MMObjectNode fragment)

Find the mediafragment of which the given mediafragment is a part. This fragment is not a subfragment itself, and should be linked to the actual sources.

Parameters:

fragment - sub media fragment

Returns:

The parent media fragment or null if it has not.

getSources

public List<MMObjectNode> getSources(MMObjectNode fragment)

Get all mediasources belonging to this mediafragment (scope should be protected)

Parameters:

fragment - the mediafragment

Returns:

All mediasources related to given mediafragment

removeSources

public void removeSources(MMObjectNode fragment)

Removes related media sources. This can be used by automatic recording VWMS's.

Parameters:

fragment - The MMObjectNode

replace

public String replace(PageInfo sp,
                      StringTokenizer command)

Replace all for frontend code Replace commands available are GETURL (gets mediafile url for an objectnumber),

Overrides:

replace in class MMObjectBuilder

Parameters:

sp - the PageInfo

command - the stringtokenizer reference with the replace command.

Returns:

the result value of the replace command or null.

getObjectValue

public Object getObjectValue(MMObjectNode node,
                             String field)

Description copied from class: MMObjectBuilder

Like getValue, but without the 'old' code (short_ html_ etc). This is for protected use, when you are sure this is not used, and you can avoid the overhead.

Overrides:

getObjectValue in class MMObjectBuilder

See Also:

MMObjectBuilder.getValue(org.mmbase.module.core.MMObjectNode, java.lang.String)

setValue

public boolean setValue(MMObjectNode node,
                        String fieldname)

Description copied from class: MMObjectBuilder

Provides additional functionality when setting field values. This method is called whenever a Node of the builder's type tries to change a value. It allows the system to add functionality such as checking valid data. Derived builders should override this method if they want to add functionality.

Overrides:

setValue in class MMObjectBuilder

Parameters:

node - the node whose fields are changed

fieldname - the fieldname that is changed

Returns:

true if the call was handled.

equals

public boolean equals(MMObjectNode o1,
                      MMObjectNode o2)

Implements equals for nodes (this is in MMObjectBuilder because you cannot override MMObjectNode) Stack.contains is used, so make sure equal node are equal.

Overrides:

equals in class MMObjectBuilder