com.groupdocs.redaction.redactions

Class MetadataRedaction

java.lang.Object

com.groupdocs.redaction.Redaction

com.groupdocs.redaction.redactions.MetadataRedaction

Direct Known Subclasses:

EraseMetadataRedaction, MetadataSearchRedaction

public abstract class MetadataRedaction
extends Redaction

Represents a base abstract class for document metadata redactions.

Learn more

• More details about document metadata redactions: Metadata redactions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetadataRedaction(int filter) Initializes a new instance of MetadataRedaction class.

Method Summary

Modifier and Type	Method and Description
protected List<MetadataItem>	applyFilter(MetadataCollection source) Applies the current Filter value to a given metadata dictionary.
RedactorLogEntry	applyTo(DocumentFormatInstance formatInstance) Applies the redaction to a given format instance.
protected abstract RedactorLogEntry	applyTo(MetadataItem item, IMetadataAccess metadata) Applies the redaction to a given metadata item.
int	getFilter() Gets the filter, which is used to select all or specific metadata, for example Author or Company.
protected abstract boolean	isApplicableTo(MetadataItem item) Checks if this redaction could be applied to a given metadata item.
void	setFilter(int value) Sets the filter, which is used to select all or specific metadata, for example Author or Company.

Methods inherited from class com.groupdocs.redaction.Redaction

getDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataRedaction

protected MetadataRedaction(int filter)

Initializes a new instance of MetadataRedaction class. This constructor requires MetadataFilters as a parameter.

Parameters:

filter - Flags enumeration MetadataFilters

Method Detail

applyFilter

protected final List<MetadataItem> applyFilter(MetadataCollection source)

Applies the current Filter value to a given metadata dictionary.

Parameters:

source - Collection of the document's metadata

Returns:

List of metadata items, conforming to the filter

applyTo

public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)

Applies the redaction to a given format instance.

Specified by:

applyTo in class Redaction

Parameters:

formatInstance - An instance of a document to apply redaction

Returns:

Status of the redaction: success/failure and error message if any

applyTo

protected abstract RedactorLogEntry applyTo(MetadataItem item,
                                            IMetadataAccess metadata)

Applies the redaction to a given metadata item.

Parameters:

item - Metadata item

metadata - Metadata access

Returns:

Redaction result

getFilter

public final int getFilter()

Gets the filter, which is used to select all or specific metadata, for example Author or Company.

Returns:

The filter, which is used to select all or specific metadata, for example Author or Company.

isApplicableTo

protected abstract boolean isApplicableTo(MetadataItem item)

Checks if this redaction could be applied to a given metadata item.

Parameters:

item - Metadata item

Returns:

True if redaction can be applied

setFilter

public final void setFilter(int value)

Sets the filter, which is used to select all or specific metadata, for example Author or Company.

Parameters:

value - The filter, which is used to select all or specific metadata, for example Author or Company.