Package org.opencastproject.mediapackage.selector

Class AbstractMediaPackageElementSelector<T extends MediaPackageElement>

java.lang.Object

org.opencastproject.mediapackage.selector.AbstractMediaPackageElementSelector<T>

All Implemented Interfaces:

MediaPackageElementSelector<T>

Direct Known Subclasses:

AttachmentSelector, CatalogSelector, SimpleElementSelector, TrackSelector

public abstract class AbstractMediaPackageElementSelector<T extends MediaPackageElement>
extends Object
implements MediaPackageElementSelector<T>

This selector will return any MediaPackageElements from a MediaPackage that matches the tag and flavors.

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	excludeTags	The tags to exclude
protected List<MediaPackageElementFlavor>	flavors	The flavors
static final String	NEGATE_TAG_PREFIX	The prefix indicating that a tag should be excluded from a search for elements using MediaPackage.getElementsByTags(Collection)
protected Set<String>	tags	The tags

Constructor Summary

Constructors

Constructor	Description
AbstractMediaPackageElementSelector()

Method Summary

Modifier and Type	Method	Description
void	addFlavor(String flavor)	Adds the given flavor to the list of flavors.
void	addFlavor(MediaPackageElementFlavor flavor)	Adds the given flavor to the list of flavors.
void	addFlavorAt(int index, String flavor)	Adds the given flavor to the list of flavors.
void	addFlavorAt(int index, MediaPackageElementFlavor flavor)	Adds the given flavor to the list of flavors.
void	addTag(String tag)	Adds tag to the list of tags that are used to select the media.
void	clearTags()	Removes all of the tags from this selector.
MediaPackageElementFlavor[]	getFlavors()	Returns the list of flavors.
String[]	getTags()	Returns the tags.
void	removeFlavor(String flavor)	Removes all occurences of the given flavor from the list of flavors.
void	removeFlavor(MediaPackageElementFlavor flavor)	Removes all occurences of the given flavor from the list of flavors.
void	removeFlavorAt(int index)	Removes all occurences of the given flavor from the list of flavors.
void	removeTag(String tag)	Adds tag to the list of tags that are used to select the media.
Collection<T>	select(List<MediaPackageElement> elements, boolean withTagsAndFlavors)	Returns the media package elements that are matched by this selector.
Collection<T>	select(MediaPackage mediaPackage, boolean withTagsAndFlavors)	This base implementation will return those media package elements that match the type specified as the type parameter to the class and that flavor (if specified) AND at least one of the tags (if specified) match.
Collection<T>	select(MediaPackage mediaPackage, String publicationChannel, boolean withTagsAndFlavors)	Similar to above, but will get media package elements from the given publication instead.
void	setFlavors(List<MediaPackageElementFlavor> flavors)	Sets the flavors.

Methods inherited from class java.lang.Object

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

Field Details

tags

protected Set<String> tags

The tags

excludeTags

protected Set<String> excludeTags

The tags to exclude

flavors

protected List<MediaPackageElementFlavor> flavors

The flavors

NEGATE_TAG_PREFIX

public static final String NEGATE_TAG_PREFIX

The prefix indicating that a tag should be excluded from a search for elements using MediaPackage.getElementsByTags(Collection)

See Also:

• Constant Field Values

Constructor Details

AbstractMediaPackageElementSelector

public AbstractMediaPackageElementSelector()

Method Details

select

public Collection<T> select(MediaPackage mediaPackage,
 boolean withTagsAndFlavors)

This base implementation will return those media package elements that match the type specified as the type parameter to the class and that flavor (if specified) AND at least one of the tags (if specified) match.

Specified by:

select in interface MediaPackageElementSelector<T extends MediaPackageElement>

Parameters:

mediaPackage - the media package

withTagsAndFlavors - define if the elements must match with flavors and tags, or just one of these parameters

Returns:

the selected elements

select

public Collection<T> select(MediaPackage mediaPackage,
 String publicationChannel,
 boolean withTagsAndFlavors)

Similar to above, but will get media package elements from the given publication instead.

Specified by:

select in interface MediaPackageElementSelector<T extends MediaPackageElement>

Parameters:

mediaPackage - the media package

publicationChannel - the publication to get elements from

withTagsAndFlavors - define if the elements must match with flavors and tags, or just one of these parameters

Returns:

the selected elements

select

public Collection<T> select(List<MediaPackageElement> elements,
 boolean withTagsAndFlavors)

Description copied from interface: MediaPackageElementSelector

Returns the media package elements that are matched by this selector.

Specified by:

select in interface MediaPackageElementSelector<T extends MediaPackageElement>

Parameters:

elements - the elements to select from

withTagsAndFlavors - define if the elements must match with flavors and tags, or just one of these parameters

Returns:

the selected elements

setFlavors

public void setFlavors(List<MediaPackageElementFlavor> flavors)

Sets the flavors.

Note that the order is relevant to the selection of the track returned by this selector.

Parameters:

flavors - the list of flavors

Throws:

IllegalArgumentException - if the flavors list is null

addFlavor

public void addFlavor(MediaPackageElementFlavor flavor)

Adds the given flavor to the list of flavors.

Note that the order is relevant to the selection of the track returned by this selector.

Parameters:

flavor -

addFlavor

public void addFlavor(String flavor)

Adds the given flavor to the list of flavors.

Note that the order is relevant to the selection of the track returned by this selector.

Parameters:

flavor -

addFlavorAt

public void addFlavorAt(int index,
 MediaPackageElementFlavor flavor)

Adds the given flavor to the list of flavors.

Note that the order is relevant to the selection of the track returned by this selector.

Parameters:

index - the position in the list

flavor - the flavor to add

addFlavorAt

public void addFlavorAt(int index,
 String flavor)

Adds the given flavor to the list of flavors.

Note that the order is relevant to the selection of the track returned by this selector.

Parameters:

index - the position in the list

flavor - the flavor to add

removeFlavor

public void removeFlavor(MediaPackageElementFlavor flavor)

Removes all occurences of the given flavor from the list of flavors.

Parameters:

flavor - the flavor to remove

removeFlavor

public void removeFlavor(String flavor)

Removes all occurences of the given flavor from the list of flavors.

Parameters:

flavor - the flavor to remove

removeFlavorAt

public void removeFlavorAt(int index)

Removes all occurences of the given flavor from the list of flavors.

Parameters:

index - the position in the list

getFlavors

public MediaPackageElementFlavor[] getFlavors()

Returns the list of flavors.

Returns:

the flavors

addTag

public void addTag(String tag)

Adds tag to the list of tags that are used to select the media.

Parameters:

tag - the tag to include

removeTag

public void removeTag(String tag)

Adds tag to the list of tags that are used to select the media.

Parameters:

tag - the tag to include

getTags

public String[] getTags()

Returns the tags.

Returns:

the tags

clearTags

public void clearTags()

Removes all of the tags from this selector.