org.mmbase.module.builders
Class MediaParts

java.lang.Object
  |
  +--org.mmbase.module.core.MMTable
        |
        +--org.mmbase.module.core.MMObjectBuilder
              |
              +--org.mmbase.module.builders.MediaParts

Direct Known Subclasses:

AudioParts, VideoParts

public abstract class MediaParts

extends MMObjectBuilder

MediaParts is the main class for mediaobjects. All media type builders (eg. AudioParts) extend from it. MediaParts implements the replace command GETURL to get the url to a media file.
MediaParts also implements an cache which is sueful when querying lots of audioparts at once. This takes time since urls aren't stored directly in a mediapart, but through rawaudios and rawvideos. To use the cache you have to set the XML builder property 'UrlCaching' to 'true'. Default is false.
For each object whos url is requested two types of cache entries will me made. One is for requests coming from the internal www server, and one for requests coming from outside. i.e., VPRO uses this to send request from employees who visit the site to a local RealServer instead of the main RealServer.
If an audiopart or videopart node changes locally or remotely, the related cache entries will be removed immediately.

Version:

$Id: MediaParts.java,v 1.9 2002/04/19 09:20:42 pierre Exp $

Author:

David van Zeventer

Field Summary

static LRUHashtable

urlCache Define LRU Cache for media urls.

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

broadcastChanges, database, DEFAULT_ALINEA, DEFAULT_EOL, description, descriptions, fields, nodeCache, obj2type, OBJ2TYPE_MAX_SIZE, oType, REPLACE_CACHE, searchAge, sortedDBLayout, TEMPNODE_DEFAULT_SIZE, TemporaryNodes, virtual

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

mmb, tableName

Constructor Summary

MediaParts()

Method Summary

abstract java.lang.String	doGetUrl(scanpage sp, int number, int userSpeed, int userChannels) Retrieves the media file url elated with the object.
int	getChannelsParam(java.lang.String channels) Parses the channels parameter value.
abstract int	getMinChannels() Gets minimal channel setting from mediautil
abstract int	getMinSpeed() Gets minimal speed setting from mediautil
int	getNumberParam(java.lang.String number) Parses the number parameter value.
int	getSpeedParam(java.lang.String speed) Parses the speed parameter value.
java.lang.String	getUrl(scanpage sp, int number, int userSpeed, int userChannels) Retrieves the media file url elated with the object.
boolean	init() Initializes and gets builder properties.
boolean	nodeLocalChanged(java.lang.String machine, java.lang.String number, java.lang.String builder, java.lang.String ctype) Called when a node was changed on a local server.
boolean	nodeRemoteChanged(java.lang.String machine, java.lang.String number, java.lang.String builder, java.lang.String ctype) Called when a node was changed by a remote server.
void	removeFromUrlCache(java.lang.String number) Removes the entries related with this objectnumber from the urlCache.
boolean	removeRaws(java.lang.String buildername, int number) Removes related rawaudio/video objects.
java.lang.String	replace(scanpage sp, java.util.StringTokenizer command) Replace all for frontend code Replace commands available are GETURL (gets mediafile url for an objectnumber), from cache or not depending on builder property.

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

addField, addLocalObserver, addRemoteObserver, buildSet, checkAddTmpField, commit, convertMMNode2SQL, count, create, createAlias, created, deleteNodeCache, drop, equals, equals, executeFunction, executeFunction, fieldLocalChanged, getAge, getAliasedNode, getAncestors, getCacheNumbers, getCacheSize, getCacheSize, getClassName, getConfigFile, getDBByte, getDBKey, getDBState, getDBText, getDBType, getDefaultTeaser, getDefaultUrl, getDescendants, getDescription, getDescription, getDescriptions, getEditFields, getField, getFieldNames, getFields, getFields, getFullTableName, getFunctionParameters, getGUIIndicator, getGUIIndicator, getHardNode, getHardNode, getHTML, getInitParameter, getInitParameters, getList, getLocaleGUIIndicator, getLocaleGUIIndicator, getMachineName, getMaintainer, getNewNode, getNewTmpNode, getNextField, getNextField, getNode, getNode, getNode, getNode, getNodes, getNodeType, getNumberFromName, getObjectType, getObjectValue, getParentBuilder, getPluralName, getPluralName, getPluralNames, getQuery, getQuery, getQuery, getRelations_main, getSearchAge, getShort, getShortedByte, getShortedText, getSingularName, getSingularName, getSingularNames, getSmartPath, getSortedFields, getSortedListFields, getTableName, getTmpNode, getURLEncode, getValue, getVersion, getWAP, getXMLPath, hashCode, hostname_function, insert, insert, insertDone, isExtensionOf, isNodeCached, isVirtual, preCommit, preEdit, process, putTmpNode, readSearchResults, removeField, removeNode, removeRelations, removeTmpNode, safeCache, safeCommit, safeInsert, search, search, search, searchIn, searchIn, searchIn, searchList, searchList, searchNumbers, searchVector, searchVector, searchVector, searchVector, searchVectorIn, searchVectorIn, searchVectorIn, searchVectorIn, searchWithWhere, sendFieldChangeSignal, setDBLayout_xml, setDefaults, setDescription, setDescriptions, setInitParameter, setMaintainer, setMMBase, setParentBuilder, setPluralNames, setSearchAge, setSingularNames, setTableName, setValue, setValue, setVersion, setXMLPath, setXMLValues, signalNewObject, testValidData, toString, toString, toXML, updateFields, waitUntilNodeChanged, wrap

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

size

Methods inherited from class java.lang.Object

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

Field Detail

urlCache

public static LRUHashtable urlCache

Define LRU Cache for media urls.

Constructor Detail

MediaParts

public MediaParts()

Method Detail

init

public boolean init()

Initializes and gets builder properties.

Overrides:

init in class MMObjectBuilder

Returns:

always true

nodeLocalChanged

public boolean nodeLocalChanged(java.lang.String machine,
                                java.lang.String number,
                                java.lang.String builder,
                                java.lang.String ctype)

Called when a node was changed on a local server.

Overrides:

nodeLocalChanged in class MMObjectBuilder

Parameters:

machine - Name of the node that was changed.

number - the object number of the node that was changed.

builder - the buildername of the object that was changed

ctype - the node changed type

Returns:

true, always

nodeRemoteChanged

public boolean nodeRemoteChanged(java.lang.String machine,
                                 java.lang.String number,
                                 java.lang.String builder,
                                 java.lang.String ctype)

Called when a node was changed by a remote server.

Overrides:

nodeRemoteChanged in class MMObjectBuilder

Parameters:

machine - Name of the node that was changed.

number - the object number of the node that was changed.

builder - the buildername of the object that was changed

ctype - the node changed type

Returns:

true, always

removeFromUrlCache

public void removeFromUrlCache(java.lang.String number)

Removes the entries related with this objectnumber from the urlCache.

Parameters:

number -

removeRaws

public boolean removeRaws(java.lang.String buildername,
                          int number)

Removes related rawaudio/video objects.

Parameters:

buildername - the buildername of which type this number is.

number - objectnumber of audio/videopart.

Returns:

true if remove was succesful, false otherwise.

replace

public java.lang.String replace(scanpage sp,
                                java.util.StringTokenizer command)

Replace all for frontend code Replace commands available are GETURL (gets mediafile url for an objectnumber), from cache or not depending on builder property.

Overrides:

replace in class MMObjectBuilder

Parameters:

sp - the scanpage

sp - the stringtokenizer reference with the replace command.

Returns:

the result value of the replace command or null.

getUrl

public java.lang.String getUrl(scanpage sp,
                               int number,
                               int userSpeed,
                               int userChannels)

Retrieves the media file url elated with the object.

Parameters:

sp - the scanpage

number - objectnumber requested.

userSpeed - speed settings.

userChannels - channel settings.

Returns:

a String with url of the media file or null;

doGetUrl

public abstract java.lang.String doGetUrl(scanpage sp,
                                          int number,
                                          int userSpeed,
                                          int userChannels)

Retrieves the media file url elated with the object. A subclass must provide an implementation of this method.

Parameters:

sp - the scanpage

number - objectnumber requested.

userSpeed - speed settings.

userChannels - channel settings.

Returns:

a String with url of the media file or null;

getMinSpeed

public abstract int getMinSpeed()

Gets minimal speed setting from mediautil

Returns:

minimal speed setting

getMinChannels

public abstract int getMinChannels()

Gets minimal channel setting from mediautil

Returns:

minimal channel setting

getNumberParam

public int getNumberParam(java.lang.String number)

Parses the number parameter value.

Parameters:

number - the object number as string parameter

Returns:

the objectnumber as integer or -1 if it isn't an integer.

getSpeedParam

public int getSpeedParam(java.lang.String speed)

Parses the speed parameter value.

Parameters:

number - the speed setting as string parameter

Returns:

the speed value as integer or minimal settings if it isn't an integer.

getChannelsParam

public int getChannelsParam(java.lang.String channels)

Parses the channels parameter value.

Parameters:

channels - the channels setting as string parameter

Returns:

the channels value as integer or minimal settings if it isn't an integer.