RedactionDescription

Inheritance: java.lang.Object

public class RedactionDescription

Represents a single change action info that performed during redaction process.


Learn more

Constructors

Constructor Description
RedactionDescription(int redactionType, RedactionActionType actionType, String originalText) Initializes a new instance of RedactionDescription class without replacement information.
RedactionDescription(int redactionType, RedactionActionType actionType, String originalText, TextReplacement replacement) Initializes a new instance of RedactionDescription class with replacement information.
RedactionDescription(int redactionType, RedactionActionType actionType, RegionReplacementOptions imageAreaReplacement, String imageDetails) Initializes a new instance of RedactionDescription class with image area replacement information.

Methods

Method Description
getRedactionType() Gets the type of document’s data - text, metadata or annotations.
getActionType() Gets the redaction operation: replacement, cleanup or deletion.
getOriginalText() Gets the matched text, if any expression is provided.
getReplacement() Gets the replacement information, can be null.
getImageAreaReplacement() Gets the replacement information for image area redactions, returns null for textual redactions.
getDetails() Gets an optional details information for the item being redacted.
setDetails(String value) Sets an optional details information for the item being redacted.

RedactionDescription(int redactionType, RedactionActionType actionType, String originalText)

public RedactionDescription(int redactionType, RedactionActionType actionType, String originalText)

Initializes a new instance of RedactionDescription class without replacement information.

Parameters:

Parameter Type Description
redactionType int Type of data being redacted
actionType RedactionActionType Action to be performed on these data
originalText java.lang.String Matched text, comment or annotation body

RedactionDescription(int redactionType, RedactionActionType actionType, String originalText, TextReplacement replacement)

public RedactionDescription(int redactionType, RedactionActionType actionType, String originalText, TextReplacement replacement)

Initializes a new instance of RedactionDescription class with replacement information.

Parameters:

Parameter Type Description
redactionType int Type of data being redacted
actionType RedactionActionType Action to be performed on these data
originalText java.lang.String Matched text, comment or annotation body
replacement TextReplacement Replacement text, matched text and its position within original string

RedactionDescription(int redactionType, RedactionActionType actionType, RegionReplacementOptions imageAreaReplacement, String imageDetails)

public RedactionDescription(int redactionType, RedactionActionType actionType, RegionReplacementOptions imageAreaReplacement, String imageDetails)

Initializes a new instance of RedactionDescription class with image area replacement information.

Parameters:

Parameter Type Description
redactionType int Type of data being redacted
actionType RedactionActionType Action to be performed on these data
imageAreaReplacement RegionReplacementOptions Image area replacement information
imageDetails java.lang.String Image textual description, by default it is String.Empty

getRedactionType()

public final int getRedactionType()

Gets the type of document’s data - text, metadata or annotations.

Returns: int - The type of document’s data - text, metadata or annotations.

getActionType()

public final RedactionActionType getActionType()

Gets the redaction operation: replacement, cleanup or deletion.

Returns: RedactionActionType - The redaction operation: replacement, cleanup or deletion.

getOriginalText()

public final String getOriginalText()

Gets the matched text, if any expression is provided.

Returns: java.lang.String - The matched text, if any expression is provided.

getReplacement()

public final TextReplacement getReplacement()

Gets the replacement information, can be null.

Returns: TextReplacement - The replacement information, can be null.

getImageAreaReplacement()

public final RegionReplacementOptions getImageAreaReplacement()

Gets the replacement information for image area redactions, returns null for textual redactions.

Returns: RegionReplacementOptions - The replacement information for image area redactions, returns null for textual redactions.

getDetails()

public final String getDetails()

Gets an optional details information for the item being redacted.

Returns: java.lang.String - An optional details information for the item being redacted.

setDetails(String value)

public final void setDetails(String value)

Sets an optional details information for the item being redacted.

Parameters:

Parameter Type Description
value java.lang.String An optional details information for the item being redacted.