Package org.opencastproject.mediapackage.elementbuilder

Class PublicationBuilderPlugin

java.lang.Object

org.opencastproject.mediapackage.elementbuilder.AbstractElementBuilderPlugin

org.opencastproject.mediapackage.elementbuilder.PublicationBuilderPlugin

All Implemented Interfaces:

MediaPackageElementBuilderPlugin

public class PublicationBuilderPlugin
extends AbstractElementBuilderPlugin

Field Summary

Fields inherited from class org.opencastproject.mediapackage.elementbuilder.AbstractElementBuilderPlugin

mimeTypes, priority, xpath

Constructor Summary

Constructors

Constructor	Description
PublicationBuilderPlugin()

Method Summary

Modifier and Type	Method	Description
boolean	accept(URI uri, MediaPackageElement.Type type, MediaPackageElementFlavor flavor)	This method is called on every registered media package builder plugin until one of these plugins returns true.
boolean	accept(MediaPackageElement.Type type, MediaPackageElementFlavor flavor)	This method is called if the media package builder tries to create a new media package element of type elementType.
boolean	accept(Node elementNode)	This method is called while the media package builder parses a media package manifest.
MediaPackageElement	elementFromManifest(Node elementNode, MediaPackageSerializer serializer)	Creates a media package element from the DOM element.
MediaPackageElement	elementFromURI(URI uri)	Creates a media package element from the given url that was previously accepted.
MediaPackageElement	newElement(MediaPackageElement.Type type, MediaPackageElementFlavor flavor)	Creates a new media package element of the specified type.

Methods inherited from class org.opencastproject.mediapackage.elementbuilder.AbstractElementBuilderPlugin

destroy, getPriority, init, setPriority

Methods inherited from class java.lang.Object

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

Constructor Details

PublicationBuilderPlugin

public PublicationBuilderPlugin()

Method Details

accept

public boolean accept(MediaPackageElement.Type type,
 MediaPackageElementFlavor flavor)

Description copied from interface: MediaPackageElementBuilderPlugin

This method is called if the media package builder tries to create a new media package element of type elementType.

Every registered builder plugin will then be asked whether it is able to create a media package element from the given element type. If this is the case for a plugin, it will then be asked to create such an element by a call to MediaPackageElementBuilderPlugin.newElement(org.opencastproject.mediapackage.MediaPackageElement.Type,MediaPackageElementFlavor).

Parameters:

type - the type

flavor - the element flavor

Returns:

true if the plugin is able to create such an element

accept

public boolean accept(URI uri,
 MediaPackageElement.Type type,
 MediaPackageElementFlavor flavor)

Description copied from interface: MediaPackageElementBuilderPlugin

This method is called on every registered media package builder plugin until one of these plugins returns true. If no plugin recognises the file, it is rejected.

The parameters type and flavor may be taken as strong hints and may both be null.

Implementers schould return the correct mime type for the given file if they are absolutely sure about the file. Otherwise, null should be returned.

Parameters:

uri - the element location

type - the element type

flavor - the element flavor

Returns:

true if the plugin can handle the element

accept

public boolean accept(Node elementNode)

Description copied from interface: MediaPackageElementBuilderPlugin

This method is called while the media package builder parses a media package manifest.

Every registered builder plugin will then be asked, whether it is able to create a media package element from the given element definition.

The element must then be constructed and returned in the call to MediaPackageElementBuilderPlugin.elementFromManifest(Node, MediaPackageSerializer).

Parameters:

elementNode - the node

Returns:

true if the plugin is able to create such an element

elementFromURI

public MediaPackageElement elementFromURI(URI uri)
                                   throws UnsupportedElementException

Description copied from interface: MediaPackageElementBuilderPlugin

Creates a media package element from the given url that was previously accepted.

Parameters:

uri - the element location

Returns:

the new media package element

Throws:

UnsupportedElementException - if creating the media package element fails

elementFromManifest

public MediaPackageElement elementFromManifest(Node elementNode,
 MediaPackageSerializer serializer)
                                        throws UnsupportedElementException

Description copied from interface: MediaPackageElementBuilderPlugin

Creates a media package element from the DOM element.

Parameters:

elementNode - the DOM node

serializer - the media package serializer

Returns:

the media package element

Throws:

UnsupportedElementException

newElement

public MediaPackageElement newElement(MediaPackageElement.Type type,
 MediaPackageElementFlavor flavor)

Description copied from interface: MediaPackageElementBuilderPlugin

Creates a new media package element of the specified type.

Parameters:

type - the element type

flavor - the element flavor

Returns:

the new media package element