cc.redberry.core.context

Interface IndexSymbolConverter

All Known Implementing Classes:

GreekLaTeXLowerCaseConverter, GreekLaTeXUpperCaseConverter, IndexConverterExtender, IndexWithStrokeConverter, LatinLowerCaseConverter, LatinUpperCaseConverter

public interface IndexSymbolConverter

Interface, which states common functionality of string-integer converter for indices of the same particular type.

Since:

1.0

See Also:

IndicesUtils

Method Summary

Modifier and Type	Method and Description
boolean	applicableToSymbol(java.lang.String symbol) Returns true if this converter can convert index string to integer representation
int	getCode(java.lang.String symbol) Returns integer representation from specified string representation of single index.
java.lang.String	getSymbol(int code, OutputFormat outputFormat) Returns string representation from specified integer representation of single index in the specified outputFormat.
byte	getType() Returns the type of indices, which this converter processes.
int	maxNumberOfSymbols() Returns the number of symbols, supported by this converter.

Method Detail

applicableToSymbol

boolean applicableToSymbol(java.lang.String symbol)

Returns true if this converter can convert index string to integer representation

Parameters:

symbol - index string representation

Returns:

true, if this converter can convert index string to integer representation

getSymbol

java.lang.String getSymbol(int code,
                           OutputFormat outputFormat)
                    throws IndexConverterException

Returns string representation from specified integer representation of single index in the specified outputFormat.

Parameters:

code - index integer representation

outputFormat - output format

Returns:

string representation of specified integer index, according to the specified output format

Throws:

IndexConverterException - if code does not corresponds to this converter

See Also:

OutputFormat

getCode

int getCode(java.lang.String symbol)
     throws IndexConverterException

Returns integer representation from specified string representation of single index.

Parameters:

symbol - index string representation

Returns:

index integer representation

Throws:

IndexConverterException - if converter does not applicable to specified symbol

maxNumberOfSymbols

int maxNumberOfSymbols()

Returns the number of symbols, supported by this converter. For example LatinLowerCaseConverter supports 26 symbols (Latin alphabet size).

Returns:

the number of symbols, supported by this converter

getType

byte getType()

Returns the type of indices, which this converter processes. The type value is unique for each converter.

Returns:

type of indices, which this converter process