com.day.cq.dam.commons.metadata

Class XmpFilterBlackWhite

java.lang.Object

com.day.cq.dam.commons.metadata.XmpFilterBlackWhite

All Implemented Interfaces:

XmpFilter

public class XmpFilterBlackWhite
extends Object
implements XmpFilter

The XmpFilter class is used to reduce Extensible Metadata Platform (XMP) properties to a desired subset using various <* configuration options such as white- and blacklists.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ApplyBlackList
static String	ApplyWhiteList
static String	BlackList
static String	WhiteList

Constructor Summary

Constructors

Constructor and Description
XmpFilterBlackWhite()

Method Summary

Modifier and Type	Method and Description
InputStream	filter(InputStream xmpIS) Filter XMP properties from an XML inputstream and return the filtered XML in a new inputstream.
boolean	isActive()
void	setConfig(Dictionary cfg)
InputStream	sieve(InputStream xmpIS) Sieve XMP properties from an XML inputstream and return the properties hold back during filtering in a new XMP document.

Methods inherited from class java.lang.Object

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

Field Detail

ApplyWhiteList

public static final String ApplyWhiteList

See Also:

Constant Field Values

WhiteList

public static final String WhiteList

See Also:

Constant Field Values

ApplyBlackList

public static final String ApplyBlackList

See Also:

Constant Field Values

BlackList

public static final String BlackList

See Also:

Constant Field Values

Constructor Detail

XmpFilterBlackWhite

public XmpFilterBlackWhite()

Method Detail

setConfig

public void setConfig(Dictionary cfg)

isActive

public boolean isActive()

Specified by:

isActive in interface XmpFilter

filter

public InputStream filter(InputStream xmpIS)
                   throws IOException

Description copied from interface: XmpFilter

Filter XMP properties from an XML inputstream and return the filtered XML in a new inputstream.

Specified by:

filter in interface XmpFilter

Parameters:

xmpIS - the XML for filtering

Returns:

the filtered XML in utf-8 encoding

Throws:

IOException

sieve

public InputStream sieve(InputStream xmpIS)
                  throws IOException

Description copied from interface: XmpFilter

Sieve XMP properties from an XML inputstream and return the properties hold back during filtering in a new XMP document. Sieving is the opposite of filtering in regard to XMP XMP elements with one exception: sieve will never return partial properties. This means, XmpFilter.filter(InputStream) may return the partial contents of an array XMP property (e.g. the first 10 entries). XmpFilter.sieve(InputStream) will either report the complete array or ignore the property. Example: during ingestion, all but the first entry in xmpMM:History is filtered. The reported metadata contains just this one entry. If this metadata was written back to the document, all existing subsequent xmpMM:History entries would be overwritten and lost. The XmpFilter.sieve(InputStream), called on the original data, will return such a property in full, e.g. the complete xmpMM:History. This allows the caller to merge changes as it desires.

Specified by:

sieve in interface XmpFilter

Parameters:

xmpIS - the XML for sieving

Returns:

the filtered XML in utf-8 encoding

Throws:

IOException