cc.redberry.core.context.defaults

Class IndexWithStrokeConverter

java.lang.Object

cc.redberry.core.context.defaults.IndexWithStrokeConverter

All Implemented Interfaces:

IndexSymbolConverter

public final class IndexWithStrokeConverter
extends java.lang.Object
implements IndexSymbolConverter

IndexSymbolConverter for letters with strokes (e.g. \\alpha' or A'').

Since:

1.1

Constructor Summary

Constructors

Constructor and Description
IndexWithStrokeConverter(IndexSymbolConverter converter, byte numberOfStrokes) Creates IndexSymbolConverter for subscripted symbols from specified converter.

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 mode) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexWithStrokeConverter

public IndexWithStrokeConverter(IndexSymbolConverter converter,
                                byte numberOfStrokes)

Creates IndexSymbolConverter for subscripted symbols from specified converter.

Parameters:

converter - converter to be extended with symbols with strokes

numberOfStrokes - number of strokes to be appended after symbol

Method Detail

applicableToSymbol

public boolean applicableToSymbol(java.lang.String symbol)

Description copied from interface: IndexSymbolConverter

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

Specified by:

applicableToSymbol in interface IndexSymbolConverter

Parameters:

symbol - index string representation

Returns:

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

getSymbol

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

Description copied from interface: IndexSymbolConverter

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

Specified by:

getSymbol in interface IndexSymbolConverter

Parameters:

code - index integer representation

mode - 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

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

Description copied from interface: IndexSymbolConverter

Returns integer representation from specified string representation of single index.

Specified by:

getCode in interface IndexSymbolConverter

Parameters:

symbol - index string representation

Returns:

index integer representation

Throws:

IndexConverterException - if converter does not applicable to specified symbol

maxNumberOfSymbols

public int maxNumberOfSymbols()

Description copied from interface: IndexSymbolConverter

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

Specified by:

maxNumberOfSymbols in interface IndexSymbolConverter

Returns:

the number of symbols, supported by this converter

getType

public byte getType()

Description copied from interface: IndexSymbolConverter

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

Specified by:

getType in interface IndexSymbolConverter

Returns:

type of indices, which this converter process