christophedelory.playlist.smil
Class Smil

java.lang.Object
  christophedelory.playlist.smil.Core
      christophedelory.playlist.smil.Smil

All Implemented Interfaces:

SpecificPlaylist

public class Smil
extends Core
implements SpecificPlaylist

Acts as the root element for all SMIL Host Language conformant language profiles.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Smil()

Method Summary

void	acceptDown(SmilVisitor visitor) Accepts the specified SMIL playlist visitor.
List<Reference>	findReferencesFromRegionId(String regionId) Finds all SMIL references assigned to the specified region.
Body	getBody() Returns the body of this SMIL presentation, if any.
Head	getHeader() Returns the header of this SMIL presentation, if any.
SpecificPlaylistProvider	getProvider() Returns the provider of this specific playlist.
void	setBody(Body body) Initializes the body of this SMIL presentation.
void	setHeader(Head header) Initializes the header of this SMIL presentation.
void	setProvider(SpecificPlaylistProvider provider) Initializes the provider of this specific playlist.
Playlist	toPlaylist() Builds a generic representation from this specific playlist.
void	writeTo(OutputStream out, String encoding) Writes this specific playlist to the specified output stream.

Methods inherited from class christophedelory.playlist.smil.Core

getClassName, getId, getLang, getTitle, setClassName, setId, setLang, setTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

Smil

public Smil()

Method Detail

setProvider

public void setProvider(SpecificPlaylistProvider provider)

Description copied from interface: SpecificPlaylist

Initializes the provider of this specific playlist.

Specified by:

setProvider in interface SpecificPlaylist

Parameters:

provider - the provider of this playlist. Shall not be null.

See Also:

SpecificPlaylist.getProvider()

getProvider

public SpecificPlaylistProvider getProvider()

Description copied from interface: SpecificPlaylist

Returns the provider of this specific playlist.

Specified by:

getProvider in interface SpecificPlaylist

Returns:

the provider of this playlist. May be null.

See Also:

SpecificPlaylist.setProvider(christophedelory.playlist.SpecificPlaylistProvider)

writeTo

public void writeTo(OutputStream out,
                    String encoding)
             throws Exception

Description copied from interface: SpecificPlaylist

Writes this specific playlist to the specified output stream. When done, the stream may be flushed, but not closed.

Specified by:

writeTo in interface SpecificPlaylist

Parameters:

out - an output stream. Shall not be null.

encoding - the content encoding of the output resource, or null if not known.

Throws:

NullPointerException - if out is null.

Exception - if any error occurs during the marshalling process.

See Also:

SpecificPlaylistFactory.readFrom(java.net.URL), SpecificPlaylistProvider.readFrom(java.io.InputStream, java.lang.String, org.apache.commons.logging.Log)

toPlaylist

public Playlist toPlaylist()

Description copied from interface: SpecificPlaylist

Builds a generic representation from this specific playlist.

Specified by:

toPlaylist in interface SpecificPlaylist

Returns:

a generic playlist. Shall not be null.

See Also:

SpecificPlaylistProvider.toSpecificPlaylist(christophedelory.playlist.Playlist)

getHeader

public Head getHeader()

Returns the header of this SMIL presentation, if any.

Returns:

an header element. May be null.

See Also:

setHeader(christophedelory.playlist.smil.Head)

setHeader

public void setHeader(Head header)

Initializes the header of this SMIL presentation.

Parameters:

header - an header element. May be null.

See Also:

getHeader()

getBody

public Body getBody()

Returns the body of this SMIL presentation, if any.

Returns:

the body element. May be null.

See Also:

setBody(christophedelory.playlist.smil.Body)

setBody

public void setBody(Body body)

Initializes the body of this SMIL presentation.

Parameters:

body - a body element. May be null.

See Also:

getBody()

acceptDown

public void acceptDown(SmilVisitor visitor)

Accepts the specified SMIL playlist visitor.

Parameters:

visitor - a SMIL playlist visitor. Shall not be null.

Throws:

NullPointerException - if visitor is null.

findReferencesFromRegionId

public List<Reference> findReferencesFromRegionId(String regionId)

Finds all SMIL references assigned to the specified region.

Parameters:

regionId - a SMIL region identifier. Should not be null.

Returns:

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

Throws:

NullPointerException - if regionId is null.

See Also:

AbstractSmilElement.getRegionString()