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

public Class OrdinalsToSuperscriptFormatter

extends Formatter
Class Inheritance
Imports
java.util.Objects, java.util.regex.Matcher, .Pattern, org.jabref.logic.cleanup.Formatter, org.jabref.logic.l10n.Localization
This class transforms ordinal numbers into LaTeX superscripts.

Field Summary

Modifier and TypeField and Description
private static final Pattern
SUPERSCRIPT_DETECT_PATTERN

private static final String
SUPERSCRIPT_REPLACE_PATTERN

Constructor Summary

AccessConstructor and Description
public
OrdinalsToSuperscriptFormatter()

Method Summary

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

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

Converts ordinal numbers to superscripts, e.g. 1st, 2nd or 3rd.

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

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

Field Detail

SUPERSCRIPT_DETECT_PATTERNback to summary
private static final Pattern SUPERSCRIPT_DETECT_PATTERN
SUPERSCRIPT_REPLACE_PATTERNback to summary
private static final String SUPERSCRIPT_REPLACE_PATTERN

Constructor Detail

OrdinalsToSuperscriptFormatterback to summary
public OrdinalsToSuperscriptFormatter()

Method Detail

formatback to summary
public String format(String value)

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

Converts ordinal numbers to superscripts, e.g. 1st, 2nd or 3rd. Will replace ordinal numbers even if they are semantically wrong, e.g. 21rd

Example

1st Conf. Cloud Computing -> 1\textsuperscript{st} Conf. Cloud Computing
Parameters
value:String

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

the input String

Returns:String

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

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