Top Fields Constructors Methods
org.jabref.logic.formatter.bibtexfields

public Class RegexFormatter

extends Formatter
Class Inheritance
Imports
java.util.ArrayList, .List, .Objects, java.util.regex.Matcher, .Pattern, .PatternSyntaxException, org.jabref.logic.cleanup.Formatter, org.jabref.logic.l10n.Localization, org.slf4j.Logger, .LoggerFactory

Field Summary

Modifier and TypeField and Description
private static final Pattern
CONSTRUCTOR_ARGUMENT

Matches a valid argument to the constructor.

private static final Pattern
ENCLOSED_IN_CURLY_BRACES

Matches text enclosed in curly brackets.

private static final Pattern
ESCAPED_CLOSING_CURLY_BRACE

private static final Pattern
ESCAPED_OPENING_CURLY_BRACE

public static final String
KEY

private static final Logger
LOGGER

private static final String
PLACEHOLDER_FOR_CLOSING_CURLY_BRACE

private static final String
PLACEHOLDER_FOR_OPENING_CURLY_BRACE

private static final String
PLACEHOLDER_FOR_PROTECTED_GROUP

private final String
regex

private static final String
REGEX_CAPTURING_GROUP

private final String
replacement

private static final String
REPLACEMENT_CAPTURING_GROUP

Constructor Summary

AccessConstructor and Description
public
RegexFormatter(String
the regular expressions for matching and replacing given in the form ("<regex>", "<replace>").
input)

Constructs a new regular expression-based formatter with the given RegEx.

Method Summary

Modifier and TypeMethod and Description
public String
format(final String
the input String
input)

Implements abstract org.jabref.logic.cleanup.Formatter.format.

Formats a field value by with a particular formatter transformation.

public String
getDescription()

Implements abstract org.jabref.logic.cleanup.Formatter.getDescription.

Returns a description of the formatter.

public String
getExampleInput()

Implements abstract org.jabref.logic.cleanup.Formatter.getExampleInput.

Returns an example input string of the formatter.

public String
getKey()

Implements abstract org.jabref.logic.cleanup.Formatter.getKey.

Returns a unique key for the formatter that can be used for its identification

public String
getName()

Implements abstract org.jabref.logic.cleanup.Formatter.getName.

Returns a human readable name of the formatter usable for e.g. in the GUI

private String
replaceHonoringProtectedGroups(final String input)

Inherited from org.jabref.logic.cleanup.Formatter:
equalshashCode

Field Detail

CONSTRUCTOR_ARGUMENTback to summary
private static final Pattern CONSTRUCTOR_ARGUMENT

Matches a valid argument to the constructor. Two capturing groups are used to parse the RegexFormatter#regex and RegexFormatter#replacement used in RegexFormatter#format(String)

ENCLOSED_IN_CURLY_BRACESback to summary
private static final Pattern ENCLOSED_IN_CURLY_BRACES

Matches text enclosed in curly brackets. The capturing group is used to prevent part of the input from being replaced.

ESCAPED_CLOSING_CURLY_BRACEback to summary
private static final Pattern ESCAPED_CLOSING_CURLY_BRACE
ESCAPED_OPENING_CURLY_BRACEback to summary
private static final Pattern ESCAPED_OPENING_CURLY_BRACE
KEYback to summary
public static final String KEY
LOGGERback to summary
private static final Logger LOGGER
PLACEHOLDER_FOR_CLOSING_CURLY_BRACEback to summary
private static final String PLACEHOLDER_FOR_CLOSING_CURLY_BRACE
PLACEHOLDER_FOR_OPENING_CURLY_BRACEback to summary
private static final String PLACEHOLDER_FOR_OPENING_CURLY_BRACE
PLACEHOLDER_FOR_PROTECTED_GROUPback to summary
private static final String PLACEHOLDER_FOR_PROTECTED_GROUP
regexback to summary
private final String regex
REGEX_CAPTURING_GROUPback to summary
private static final String REGEX_CAPTURING_GROUP
replacementback to summary
private final String replacement
REPLACEMENT_CAPTURING_GROUPback to summary
private static final String REPLACEMENT_CAPTURING_GROUP

Constructor Detail

RegexFormatterback to summary
public RegexFormatter(String input)

Constructs a new regular expression-based formatter with the given RegEx.

Parameters
input:String

the regular expressions for matching and replacing given in the form ("<regex>", "<replace>").

Method Detail

formatback to summary
public String format(final String input)

Implements abstract org.jabref.logic.cleanup.Formatter.format.

Doc from org.jabref.logic.cleanup.Formatter.format.

Formats a field value by with a particular formatter transformation.

Calling this method with a null argument results in a NullPointerException.

Parameters
input:String

the input String

Returns:String

the formatted output String

Annotations
@Override
getDescriptionback to summary
public String getDescription()

Implements abstract org.jabref.logic.cleanup.Formatter.getDescription.

Doc from org.jabref.logic.cleanup.Formatter.getDescription.

Returns a description of the formatter.

Returns:String

the description string, always non empty

Annotations
@Override
getExampleInputback to summary
public String getExampleInput()

Implements abstract org.jabref.logic.cleanup.Formatter.getExampleInput.

Doc from org.jabref.logic.cleanup.Formatter.getExampleInput.

Returns an example input string of the formatter. This example is used as input to the formatter to demonstrate its functionality

Returns:String

the example input string, always non empty

Annotations
@Override
getKeyback to summary
public String getKey()

Implements abstract org.jabref.logic.cleanup.Formatter.getKey.

Doc from org.jabref.logic.cleanup.Formatter.getKey.

Returns a unique key for the formatter that can be used for its identification

Returns:String

the key of the formatter, always not null

Annotations
@Override
getNameback to summary
public String getName()

Implements abstract org.jabref.logic.cleanup.Formatter.getName.

Doc from org.jabref.logic.cleanup.Formatter.getName.

Returns a human readable name of the formatter usable for e.g. in the GUI

Returns:String

the name of the formatter, always not null

Annotations
@Override
replaceHonoringProtectedGroupsback to summary
private String replaceHonoringProtectedGroups(final String input)