com.groupdocs.parser.templates

Class TemplateRegexPosition

java.lang.Object

com.groupdocs.parser.templates.TemplatePosition

com.groupdocs.parser.templates.TemplateRegexPosition

public class TemplateRegexPosition
extends TemplatePosition

Provides a template field position which uses the regular expression.

The following example shows the situation if the document contains "Invoice Number INV-12345" then template field can be defined in the following way:

 // Create a regex template field with "InvoiceNumber" name
 TemplateField templateField = new TemplateField(
     new TemplateRegexPosition("Invoice Number\\s+[A-Z0-9\\-]+"),
     "InvoiceNumber");
 

In this case as a value the entire string is extracted. To extract only a part of the string the regular expression group "value" is used:

 // Create a regex template field with "InvoiceNumber" name with "value" group
 TemplateField templateField = new TemplateField(
     new TemplateRegexPosition("Invoice Number\\s+(?<value>[A-Z0-9\\-]+)"),
     "InvoiceNumber");

In this case as a value "INV-3337" string is extracted.

Constructor Summary

Constructors

Constructor and Description
TemplateRegexPosition(String expression) Initializes a new instance of the TemplateRegexPosition class.
TemplateRegexPosition(String expression, boolean matchCase) Initializes a new instance of the TemplateRegexPosition class.

Method Summary

Modifier and Type	Method and Description
String	getExpression() Gets the regular expression.
boolean	isMatchCase() Gets the value that indicates whether a text case isn't ignored.
TemplatePosition	scale(double factor) Creates a copy of the current position with all coordinates scaled by the given factor.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateRegexPosition

public TemplateRegexPosition(String expression)

Initializes a new instance of the TemplateRegexPosition class.

Parameters:

expression - The regular expression.

TemplateRegexPosition

public TemplateRegexPosition(String expression,
                             boolean matchCase)

Initializes a new instance of the TemplateRegexPosition class.

Parameters:

expression - The regular expression.

matchCase - The value that indicates whether a text case isn't ignored.

Method Detail

getExpression

public String getExpression()

Gets the regular expression.

Returns:

A string that represents the regular expression.

isMatchCase

public boolean isMatchCase()

Gets the value that indicates whether a text case isn't ignored.

Returns:

true if a text case isn't ignored; otherwise, false.

scale

public TemplatePosition scale(double factor)

Description copied from class: TemplatePosition

Creates a copy of the current position with all coordinates scaled by the given factor.

Specified by:

scale in class TemplatePosition

Parameters:

factor - The scaling factor.

Returns:

A new TemplatePosition with scaled coordinates.