Package com.exedio.cope.pattern

Class MediaFilter

java.lang.Object

com.exedio.cope.Feature

com.exedio.cope.Pattern

com.exedio.cope.pattern.MediaPath

com.exedio.cope.pattern.MediaFilter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MediaImageioFilter, TextUrlFilter, TextUrlFilterDelegator

public abstract class MediaFilter
extends MediaPath

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exedio.cope.pattern.MediaPath

MediaPath.Locator, MediaPath.Log, MediaPath.NotFound

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MediaFilter(Media source)

Method Summary

Modifier and Type	Method	Description
Date	getLastModified(Item item)	The default implementation returns null.
MediaPath.Locator	getLocatorWithFallbackToSource(Item item)	Returns the same result as getLocator, if this filter supports filtering the source media for this item.
Media	getSource()
abstract Set<String>	getSupportedSourceContentTypes()
String	getURLWithFallbackToSource(Item item)	Returns the same result as getURL, if this filter supports filtering the source media for this item.
boolean	isFinal()	Returns, whether the contents of this media path may change or not.
boolean	isMandatory()	A MediaPath is "mandatory" if MediaPath.getContentType(Item) and MediaPath.getLocator(Item) will not return null for any item.
Condition	isNotNull()	Returns a condition matching all items, for which MediaPath.getLocator(Item) does not return null.
Condition	isNotNull(Join join)	Returns a condition matching all items, for which MediaPath.getLocator(Item) does not return null.
Condition	isNull()	Returns a condition matching all items, for which MediaPath.getLocator(Item) returns null.
Condition	isNull(Join join)	Returns a condition matching all items, for which MediaPath.getLocator(Item) returns null.

Methods inherited from class com.exedio.cope.pattern.MediaPath

commit, doGetAndCommit, getContentType, getExceptionLogs, getGuessedUrlLogs, getInfo, getInvalidSpecialLogs, getIsNullLogs, getLocator, getNamedURL, getNoSuchItemLogs, getNoSuchPath, getNoSuchPathLogs, getNotAnItemLogs, getNotComputableLogs, getURL, incrementDelivered, isContentTypeWrapped, isUrlFingerPrinted, isUrlGuessingPrevented, isUrlGuessingPreventedSecurely, notFoundIsNull, notFoundNotComputable, onMount

Methods inherited from class com.exedio.cope.Pattern

addSource, addSource, addSource, addSource, addSourceFeature, addSourceFeature, addSourceFeature, annotationField, equals, getGeneratedTypes, getSourceFeatures, getSourceFeaturesGather, getSourceFields, getSources, getSourceTypes, getType, hashCode, initialize, newSourceType, newSourceType, newSourceType, newSourceType, newSourceType, newSourceType, newType, newType, registerSource

Methods inherited from class com.exedio.cope.Feature

afterModelCreated, getAbstractType, getAnnotation, getID, getLocalizationKeys, getName, getPattern, isAnnotationPresent, isSourceAlready, mount, readResolve, requireMounted, toString, toString, writeReplace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MediaFilter

protected MediaFilter(Media source)

Method Detail

getSource

public final Media getSource()

getSupportedSourceContentTypes

public abstract Set<String> getSupportedSourceContentTypes()

isFinal

public boolean isFinal()

Description copied from class: MediaPath

Returns, whether the contents of this media path may change or not. The default implementation returns false.

Overrides:

isFinal in class MediaPath

getLastModified

public final Date getLastModified(Item item)

Description copied from class: MediaPath

The default implementation returns null.

Overrides:

getLastModified in class MediaPath

Parameters:

item - the item which has the LastModified information

getURLWithFallbackToSource

public final String getURLWithFallbackToSource(@Nonnull
                                               Item item)

Returns the same result as getURL, if this filter supports filtering the source media for this item. Otherwise it returns getSource().getURL(item).

getLocatorWithFallbackToSource

public final MediaPath.Locator getLocatorWithFallbackToSource(@Nonnull
                                                              Item item)

Returns the same result as getLocator, if this filter supports filtering the source media for this item. Otherwise it returns getSource().getLocator(item).

isMandatory

public final boolean isMandatory()

Description copied from class: MediaPath

A MediaPath is "mandatory" if MediaPath.getContentType(Item) and MediaPath.getLocator(Item) will not return null for any item.

Specified by:

isMandatory in class MediaPath

isNull

public final Condition isNull()

Description copied from class: MediaPath

Returns a condition matching all items, for which MediaPath.getLocator(Item) returns null.

Overrides:

isNull in class MediaPath

isNull

public final Condition isNull(Join join)

Description copied from class: MediaPath

Returns a condition matching all items, for which MediaPath.getLocator(Item) returns null.

Overrides:

isNull in class MediaPath

Parameters:

join - the join the returned condition should be bound to

isNotNull

public final Condition isNotNull()

Description copied from class: MediaPath

Returns a condition matching all items, for which MediaPath.getLocator(Item) does not return null.

Overrides:

isNotNull in class MediaPath

isNotNull

public final Condition isNotNull(Join join)

Description copied from class: MediaPath

Returns a condition matching all items, for which MediaPath.getLocator(Item) does not return null.

Overrides:

isNotNull in class MediaPath

Parameters:

join - the join the returned condition should be bound to