christophedelory.playlist.asx
Class AsxOrEntryElement

java.lang.Object
  christophedelory.playlist.asx.Child
      christophedelory.playlist.asx.AsxElement
          christophedelory.playlist.asx.AsxOrEntryElement

Direct Known Subclasses:

Asx, Entry

public class AsxOrEntryElement
extends AsxElement

The super class of the media elements ASX and ENTRY.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

AsxOrEntryElement()

Method Summary

void	addLogURL(LogURL logURL) Adds a log URL of this element.
void	addParam(Param param) Adds a parameter to this element.
String	findParamValue(String name) Searches for the parameter named from name.
TextElement	getAbstract() Returns the description of the associated element.
TextElement	getAuthor() Returns the author of a media clip or a Windows Media metafile.
Banner	getBanner() Returns the URL of a graphic file that will appear in the display panel of the associated element.
Base	getBase() Returns the URL string appended to the front of URLs sent to the WMP control.
TextElement	getCopyright() Returns the copyright information for this element.
List<LogURL>	getLogURLs() Lists all log URLs associated to this element.
MoreInfo	getMoreInfo() Returns the URL of a graphic file that will appear in the display panel of the associated element.
Hashtable<Param,Param>	getParams() Returns all parameters defined in this element.
PreviewDuration	getPreviewDuration() Returns the length of time a clip is played in preview mode.
TextElement	getTitle() Returns the title associated to this element.
void	setAbstract(TextElement abstrct) Initializes the description of the associated element.
void	setAuthor(TextElement author) Initializes the author of a media clip or a Windows Media metafile.
void	setBanner(Banner banner) Initializes the URL of a graphic file that will appear in the display panel of the associated element.
void	setBase(Base base) Initializes the URL string appended to the front of URLs sent to the WMP control.
void	setCopyright(TextElement copyright) Initializes the copyright information for this element.
void	setMoreInfo(MoreInfo moreInfo) Initializes the URL of a graphic file that will appear in the display panel of the associated element.
void	setPreviewDuration(PreviewDuration previewDuration) Initializes the preview duration.
void	setTitle(TextElement title) Initializes the title of this element.

Methods inherited from class christophedelory.playlist.asx.Child

getParent, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

AsxOrEntryElement

public AsxOrEntryElement()

Method Detail

getBase

public Base getBase()

Returns the URL string appended to the front of URLs sent to the WMP control.

Returns:

a base. May be null.

See Also:

setBase(christophedelory.playlist.asx.Base)

setBase

public void setBase(Base base)

Initializes the URL string appended to the front of URLs sent to the WMP control.

Parameters:

base - a base. May be null.

See Also:

getBase()

getTitle

public TextElement getTitle()

Returns the title associated to this element. A text string specifying the title for an ASX or ENTRY element. Each parent ASX and ENTRY element should contain at most one child TITLE element. Multiple TITLE elements after the first before the last will be ignored and will not display.

Returns:

a title. May be null.

See Also:

setTitle(christophedelory.playlist.asx.TextElement)

setTitle

public void setTitle(TextElement title)

Initializes the title of this element.

Parameters:

title - a title. May be null.

See Also:

getTitle()

getAbstract

public TextElement getAbstract()

Returns the description of the associated element. Contains text that represents a description of the associated ASX or ENTRY element. Only the first last ABSTRACT element within the scope of another element is used when an Advanced Stream Redirector (ASX) file is processed. Subsequent Other ABSTRACT elements in that scope are ignored.

Returns:

an abstract. May be null.

See Also:

setAbstract(christophedelory.playlist.asx.TextElement)

setAbstract

public void setAbstract(TextElement abstrct)

Initializes the description of the associated element.

Parameters:

abstrct - an abstract. May be null.

See Also:

getAbstract()

getAuthor

public TextElement getAuthor()

Returns the author of a media clip or a Windows Media metafile. Contains a text string representing the name of the author of an ASX file or media clip. You can use the AUTHOR element within the ASX element and within ENTRY elements. Each parent ASX and ENTRY element should contain at most one child AUTHOR element. Multiple AUTHOR elements after the first before the last will be ignored and will not display.

Returns:

an author. May be null.

See Also:

setAuthor(christophedelory.playlist.asx.TextElement)

setAuthor

public void setAuthor(TextElement author)

Initializes the author of a media clip or a Windows Media metafile.

Parameters:

author - an author. May be null.

See Also:

getAuthor()

getCopyright

public TextElement getCopyright()

Returns the copyright information for this element. Defines a text string specifying the copyright information for an ASX or ENTRY element. The characters for copyright or trademark registration symbols (© or ®) do not display properly with all international character sets. To display either of these symbols properly for all users, you should use the ASCII equivalents (c) or (r) instead. If the metafile is encoded using UTF-8, copyright and trademark symbols will display correctly. Each parent ASX and ENTRY element should contain at most one child COPYRIGHT element. Multiple COPYRIGHT elements after the first before the last will be ignored and will not display.

Returns:

a copyright. May be null.

See Also:

setCopyright(christophedelory.playlist.asx.TextElement)

setCopyright

public void setCopyright(TextElement copyright)

Initializes the copyright information for this element.

Parameters:

copyright - a copyright. May be null.

See Also:

getCopyright()

getBanner

public Banner getBanner()

Returns the URL of a graphic file that will appear in the display panel of the associated element.

Returns:

a banner. May be null.

See Also:

setBanner(christophedelory.playlist.asx.Banner)

setBanner

public void setBanner(Banner banner)

Initializes the URL of a graphic file that will appear in the display panel of the associated element.

Parameters:

banner - a banner. May be null.

See Also:

getBanner()

getMoreInfo

public MoreInfo getMoreInfo()

Returns the URL of a graphic file that will appear in the display panel of the associated element.

Returns:

supplementary information for this element. May be null.

See Also:

setMoreInfo(christophedelory.playlist.asx.MoreInfo)

setMoreInfo

public void setMoreInfo(MoreInfo moreInfo)

Initializes the URL of a graphic file that will appear in the display panel of the associated element.

Parameters:

moreInfo - supplementary information for this element. May be null.

See Also:

getMoreInfo()

getPreviewDuration

public PreviewDuration getPreviewDuration()

Returns the length of time a clip is played in preview mode.

Returns:

a preview duration. May be null.

See Also:

setPreviewDuration(christophedelory.playlist.asx.PreviewDuration)

setPreviewDuration

public void setPreviewDuration(PreviewDuration previewDuration)

Initializes the preview duration.

Parameters:

previewDuration - a preview duration. May be null.

See Also:

getPreviewDuration()

addParam

public void addParam(Param param)

Adds a parameter to this element.

Parameters:

param - a param. Shall not be null.

Throws:

NullPointerException - if param is null.

See Also:

getParams()

getParams

public Hashtable<Param,Param> getParams()

Returns all parameters defined in this element.

Returns:

a list of parameters. May be empty but not null.

See Also:

addParam(christophedelory.playlist.asx.Param)

findParamValue

public String findParamValue(String name)

Searches for the parameter named from name.

Parameters:

name - the parameter name. Shall not be null.

Returns:

the parameter value, or null if no such param could be found, or the parameter value itself is null.

Throws:

NullPointerException - if name is null.

getLogURLs

public List<LogURL> getLogURLs()

Lists all log URLs associated to this element. Allows instructing Windows Media Player to submit any log data to the specified URL for the associated element.

Returns:

a list of URLs. May be empty but not null.

See Also:

addLogURL(christophedelory.playlist.asx.LogURL)

addLogURL

public void addLogURL(LogURL logURL)

Adds a log URL of this element.

Parameters:

logURL - a log URL. Shall not be null.

Throws:

NullPointerException - if logURL is null.

See Also:

getLogURLs()