com.groupdocs.redaction.redactions

Class MetadataSearchRedaction

java.lang.Object

com.groupdocs.redaction.Redaction

com.groupdocs.redaction.redactions.MetadataRedaction

com.groupdocs.redaction.redactions.MetadataSearchRedaction

public class MetadataSearchRedaction
extends MetadataRedaction

Represents a metadata redaction that searches and redacts metadata using regular expressions, matching keys and/or values.

Learn more

• More details about applying redactions: Redaction basics
• More details about document metadata redactions: Metadata redactions

The following example demonstrates how to search and redact certain text in specific metadata.

try (Redactor redactor = new Redactor("C:\\sample.docx"))
 {
    MetadataSearchRedaction redaction = new MetadataSearchRedaction("Company Ltd.", "--company--");
    // If not set, applies to all metadata items
    redaction.setFilter( MetadataFilters.Company );
    redactor.apply(redaction);
    redactor.save();
 }
  

Constructor Summary

Constructors

Constructor and Description
MetadataSearchRedaction(Pattern valueRegex, String replacement) Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items.
MetadataSearchRedaction(Pattern valueRegex, String replacement, Pattern keyRegex) Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items.
MetadataSearchRedaction(String valuePattern, String replacement) Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items.
MetadataSearchRedaction(String valuePattern, String replacement, String keyPattern) Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items.

Method Summary

Modifier and Type	Method and Description
protected RedactorLogEntry	applyTo(MetadataItem item, IMetadataAccess metadata) Applies the redaction to a given metadata item.
String	getDescription() Returns a string, describing the redaction and its parameters.
Pattern	getKeyExpression() Gets the regular expression to match name (key) of metadata item.
String	getReplacement() Gets the textual replacement value.
Pattern	getValueExpression() Gets the regular expression to match value text of a metadata item.
protected boolean	isApplicableTo(MetadataItem item) Checks if this redaction could be applied to a given metadata item.

Methods inherited from class com.groupdocs.redaction.redactions.MetadataRedaction

applyFilter, applyTo, getFilter, setFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataSearchRedaction

public MetadataSearchRedaction(Pattern valueRegex,
                               String replacement)

Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items.

Parameters:

valueRegex - Regular expression to search and replace

replacement - Textual replacement

MetadataSearchRedaction

public MetadataSearchRedaction(Pattern valueRegex,
                               String replacement,
                               Pattern keyRegex)

Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items.

Parameters:

valueRegex - Regular expression to search and replace metadata item value

replacement - Textual replacement

keyRegex - Regular expression to search and replace metadata item name

MetadataSearchRedaction

public MetadataSearchRedaction(String valuePattern,
                               String replacement)

Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items.

Parameters:

valuePattern - Regular expression to search and replace

replacement - Textual replacement

MetadataSearchRedaction

public MetadataSearchRedaction(String valuePattern,
                               String replacement,
                               String keyPattern)

Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items.

Parameters:

valuePattern - Regular expression to search and replace metadata item value

replacement - Textual replacement

keyPattern - Regular expression to search and replace metadata item name

Method Detail

applyTo

protected RedactorLogEntry applyTo(MetadataItem item,
                                   IMetadataAccess metadata)

Applies the redaction to a given metadata item.

Specified by:

applyTo in class MetadataRedaction

Parameters:

item - Metadata item

metadata - Metadata access

Returns:

Redaction result

getDescription

public String getDescription()

Returns a string, describing the redaction and its parameters.

Overrides:

getDescription in class Redaction

Returns:

Text, containing redaction name and parameters.

getKeyExpression

public final Pattern getKeyExpression()

Gets the regular expression to match name (key) of metadata item.

Returns:

The regular expression to match name (key) of metadata item.

getReplacement

public final String getReplacement()

Gets the textual replacement value.

Returns:

The textual replacement value.

getValueExpression

public final Pattern getValueExpression()

Gets the regular expression to match value text of a metadata item.

Returns:

The regular expression to match value text of a metadata item.

isApplicableTo

protected boolean isApplicableTo(MetadataItem item)

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

Specified by:

isApplicableTo in class MetadataRedaction

Parameters:

item - Metadata item

Returns:

True if redaction can be applied