org.opencastproject.mediapackage.elementbuilder

Class AbstractAttachmentBuilderPlugin

java.lang.Object

org.opencastproject.mediapackage.elementbuilder.AbstractElementBuilderPlugin

org.opencastproject.mediapackage.elementbuilder.AbstractAttachmentBuilderPlugin

All Implemented Interfaces:

MediaPackageElementBuilderPlugin

Direct Known Subclasses:

AttachmentBuilderPlugin

public abstract class AbstractAttachmentBuilderPlugin
extends AbstractElementBuilderPlugin

This implementation of the MediaPackageElementBuilderPlugin recognizes attachments and provides utility methods for creating media package element representations for them.

Field Summary

Fields

Modifier and Type	Field and Description
protected MediaPackageElementFlavor	flavor The flavor to look for
protected MediaPackageElement.Type	type The candidate type

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

mimeTypes, priority, xpath

Constructor Summary

Constructors

Constructor and Description
AbstractAttachmentBuilderPlugin() Creates a new attachment plugin builder that will accept attachments with any flavor.
AbstractAttachmentBuilderPlugin(MediaPackageElementFlavor flavor) Creates a new attachment plugin builder that will accept attachments with the given flavor.

Method Summary

Modifier and Type	Method and Description
boolean	accept(MediaPackageElement.Type type, MediaPackageElementFlavor flavor) This implementation of accept tests for the element type (attachment).
boolean	accept(Node elementNode) This implementation of accept tests for the correct node type (attachment).
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.
MediaPackageElement	elementFromManifest(Node elementNode, MediaPackageSerializer serializer) Creates a media package element from the DOM element.
MediaPackageElement	elementFromURI(URI uri) Utility method that returns an attachment object from the given url.
MediaPackageElement	elementFromURI(URI uri, MediaPackageElement.Type type, MediaPackageElementFlavor flavor)
MediaPackageElement	newElement(MediaPackageElement.Type type, MediaPackageElementFlavor flavor) Creates a new media package element of the specified type.
protected Attachment	specializeAttachment(Attachment attachment) Overwrite this method in order to return a specialization of the attachment.
String	toString()

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, wait, wait, wait

Field Detail

type

protected MediaPackageElement.Type type

The candidate type

flavor

protected MediaPackageElementFlavor flavor

The flavor to look for

Constructor Detail

AbstractAttachmentBuilderPlugin

public AbstractAttachmentBuilderPlugin()

Creates a new attachment plugin builder that will accept attachments with any flavor.

AbstractAttachmentBuilderPlugin

public AbstractAttachmentBuilderPlugin(MediaPackageElementFlavor flavor)

Creates a new attachment plugin builder that will accept attachments with the given flavor.

Parameters:

flavor - the attachment flavor

Method Detail

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

See Also:

MediaPackageElementBuilderPlugin.accept(URI, org.opencastproject.mediapackage.MediaPackageElement.Type , org.opencastproject.mediapackage.MediaPackageElementFlavor)

accept

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

This implementation of accept tests for the element type (attachment).

Parameters:

type - the type

flavor - the element flavor

Returns:

true if the plugin is able to create such an element

See Also:

MediaPackageElementBuilderPlugin.accept(org.opencastproject.mediapackage.MediaPackageElement.Type , org.opencastproject.mediapackage.MediaPackageElementFlavor)

accept

public boolean accept(Node elementNode)

This implementation of accept tests for the correct node type (attachment).

Parameters:

elementNode - the node

Returns:

true if the plugin is able to create such an element

See Also:

MediaPackageElementBuilderPlugin.accept(org.w3c.dom.Node)

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

See Also:

MediaPackageElementBuilder.newElement(org.opencastproject.mediapackage.MediaPackageElement.Type , org.opencastproject.mediapackage.MediaPackageElementFlavor)

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

See Also:

MediaPackageElementBuilderPlugin.elementFromManifest(org.w3c.dom.Node, org.opencastproject.mediapackage.MediaPackageSerializer)

elementFromURI

public MediaPackageElement elementFromURI(URI uri)
                                   throws UnsupportedElementException

Utility method that returns an attachment object from the given url.

Parameters:

uri - the element location

Returns:

an attachment object

Throws:

UnsupportedElementException - if the attachment cannto be read

elementFromURI

public MediaPackageElement elementFromURI(URI uri,
                                          MediaPackageElement.Type type,
                                          MediaPackageElementFlavor flavor)
                                   throws UnsupportedElementException

Throws:

UnsupportedElementException

See Also:

MediaPackageElementBuilder.elementFromURI(URI, org.opencastproject.mediapackage.MediaPackageElement.Type , org.opencastproject.mediapackage.MediaPackageElementFlavor)

specializeAttachment

protected Attachment specializeAttachment(Attachment attachment)
                                   throws UnsupportedElementException

Overwrite this method in order to return a specialization of the attachment. This implementation just returns the attachment that is was given.

Parameters:

attachment - the general attachment representation

Returns:

a specialized attachment

Throws:

UnsupportedElementException - if the attachment fails to be specialized

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()