IAnnotatedDocument
public interface IAnnotatedDocument
Defines methods that are required for access to annotations, such as comments. Needs to be implemented by DocumentFormatInstance -derived class to perform annotation redactions.
Learn more
- More details about applying redactions: Redaction basics
- More details about document annotation redactions: Annotation redactions
- More details about implementing custom formats: Create custom format handler
Methods
| Method | Description |
|---|---|
| redactAnnotation(Pattern regularExpression, String replacement) | Replaces the matching text in all annotations within the document. |
| deleteAnnotations(Pattern regularExpression) | Deletes all annotations, matching regular expression within the document. |
redactAnnotation(Pattern regularExpression, String replacement)
public abstract RedactionResult redactAnnotation(Pattern regularExpression, String replacement)
Replaces the matching text in all annotations within the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| regularExpression | java.util.regex.Pattern | Regular expression to search and replace |
| replacement | java.lang.String | Textual replacement |
Returns: RedactionResult - Replacement result
deleteAnnotations(Pattern regularExpression)
public abstract RedactionResult deleteAnnotations(Pattern regularExpression)
Deletes all annotations, matching regular expression within the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| regularExpression | java.util.regex.Pattern | Regular expression to match |
Returns: RedactionResult - Deletion result