org.mmbase.applications.media.urlcomposers
Class URLComposer

java.lang.Object
  org.mmbase.applications.media.urlcomposers.URLComposer

Direct Known Subclasses:

FragmentURLComposer, SimpleWmURLComposer, WmSbURLComposer

public class URLComposer

extends java.lang.Object

URLComposer is a wrapper/container class around an URL. It contains besides the URL some extra meta information about it, like the original source object of the resource it represents and if it is currently available or not. An URL can be unavailable because of two reasons: Because the provider is offline, or because the fragment where it belongs to is not valid (e.g. because of publishtimes) It is used by the Media builders to pass around information (mainly as entry in Lists)

Author:

Michiel Meeuwissen, Rob Vermeulen (VPRO)

Field Summary

protected java.util.Map	info
protected MMObjectNode	provider
protected MMObjectNode	source

Constructor Summary

URLComposer()

Method Summary

boolean	canCompose() Returns true.
boolean	equals(java.lang.Object o)
java.lang.String	getDescription(java.util.Map options)
Format	getFormat() The format of the produced URL.
java.lang.String	getGUIIndicator(java.util.Map options)
java.util.Map	getInfo()
MMObjectNode	getProvider()
MMObjectNode	getSource()
java.lang.String	getURL() Returns the URL as a String.
protected java.lang.StringBuffer	getURLBuffer() Extension will normally create URL's differently.
void	init(MMObjectNode provider, MMObjectNode source, MMObjectNode fragment, java.util.Map info, java.util.Set cacheExpireObjects)
boolean	isAvailable()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

source

protected MMObjectNode source

provider

protected MMObjectNode provider

info

protected java.util.Map info

Constructor Detail

URLComposer

public URLComposer()

Method Detail

init

public void init(MMObjectNode provider,
                 MMObjectNode source,
                 MMObjectNode fragment,
                 java.util.Map info,
                 java.util.Set cacheExpireObjects)

getSource

public MMObjectNode getSource()

getProvider

public MMObjectNode getProvider()

getInfo

public java.util.Map getInfo()

getFormat

public Format getFormat()

The format of the produced URL. This is not necessarily the format of the source. (Though it normally would be)

getGUIIndicator

public java.lang.String getGUIIndicator(java.util.Map options)

getDescription

public java.lang.String getDescription(java.util.Map options)

canCompose

public boolean canCompose()

Returns true. This can be overridden if the URLComposer not always can do it's job. It then returns false if it is (can be?) taken from consideration.

getURLBuffer

protected java.lang.StringBuffer getURLBuffer()

Extension will normally create URL's differently. They override this function.

getURL

public final java.lang.String getURL()

Returns the URL as a String. To encourage efficient coding, this method is final. Override getURLBuffer instead.

isAvailable

public boolean isAvailable()

toString

public java.lang.String toString()

equals

public boolean equals(java.lang.Object o)