com.devexperts.qd

Interface SymbolStriper

All Known Implementing Classes:

HashStriper, MonoStriper, RangeStriper

public interface SymbolStriper

Symbol striping strategy that allows to split whole symbol universe into several smaller "stripes". Striper can be used for example to split a large QD tape into several smaller parts based on some symbol pattern.

Stripes do not intersect, each stripe has a filter that represents it. Striper should split all symbols into more than one stripe (with the exception of MonoStriper which does no splitting being essentially the "identity" striper).

Method Summary

Modifier and Type	Method and Description
static SymbolStriper	definedValueOf(DataScheme scheme, String spec) Creates SymbolStriper from the given specification for the given scheme, or throws exception.
default BitSet	getIntersectingStripes(QDFilter filter) Returns bit set of getStripeCount() size that specifies stripes that intersect with the given filter.
String	getName() Returns a string representation of this striper.
DataScheme	getScheme() Returns scheme that this striper works for.
int	getStripeCount() Returns the positive number of stripes that this striper splits into.
QDFilter	getStripeFilter(int stripeIndex) Returns filter corresponding for the given stripe index.
default int	getStripeIndex(char[] symbol, int offset, int length) Returns the index of the stripe that the given symbol (represented as character array) falls into.
int	getStripeIndex(int cipher, String symbol) Returns the index of the stripe that the given cipher-symbol pair falls into.
default int	getStripeIndex(String symbol) Returns the index of the stripe that the given symbol falls into.
String	toString() Returns a string representation of this striper.
static SymbolStriper	valueOf(DataScheme scheme, String spec) Creates SymbolStriper from the given specification for the given scheme, or null if specification is unknown.

Method Detail

getName

String getName()

Returns a string representation of this striper. This string representation should be parseable into this striper via SymbolStriperFactory.

toString

String toString()

Returns a string representation of this striper.

Overrides:

toString in class Object

See Also:

getName()

getScheme

DataScheme getScheme()

Returns scheme that this striper works for. Returns null if this striper works for any scheme.

getStripeCount

int getStripeCount()

Returns the positive number of stripes that this striper splits into.

Returns:

number of stripes (must be positive)

getStripeIndex

int getStripeIndex(int cipher,
                   String symbol)

Returns the index of the stripe that the given cipher-symbol pair falls into.

Note that wildcard symbol should not be submitted to this method, since it should be accepted by all stripes therefore making stripes intersecting each other.

Parameters:

cipher - symbol cipher

symbol - symbol string

Returns:

stripe index

See Also:

QDFilter.accept(QDContract, DataRecord, int, String)

getStripeIndex

default int getStripeIndex(String symbol)

Returns the index of the stripe that the given symbol falls into.

Parameters:

symbol - symbol string (not-null)

Returns:

stripe index

See Also:

getStripeIndex(int, String)

getStripeIndex

default int getStripeIndex(char[] symbol,
                           int offset,
                           int length)

Returns the index of the stripe that the given symbol (represented as character array) falls into.

Parameters:

symbol - array that is the source of the symbol

offset - the initial offset

length - the symbol's length

Returns:

stripe index

See Also:

getStripeIndex(int, String)

getStripeFilter

QDFilter getStripeFilter(int stripeIndex)

Returns filter corresponding for the given stripe index.

Parameters:

stripeIndex - stripe index

Returns:

QD filter for the stripe

getIntersectingStripes

default BitSet getIntersectingStripes(QDFilter filter)

Returns bit set of getStripeCount() size that specifies stripes that intersect with the given filter. If intersection cannot be calculated null can be returned.

Parameters:

filter - QD filter to check for intersection

Returns:

bitset of getStripeCount() size of intersecting stripes, or null.

valueOf

static SymbolStriper valueOf(DataScheme scheme,
                             String spec)

Creates SymbolStriper from the given specification for the given scheme, or null if specification is unknown.

Parameters:

scheme - data scheme

spec - striper specification

Returns:

striper, or null if specification is unknown

Throws:

FilterSyntaxException - if spec is invalid.

definedValueOf

static SymbolStriper definedValueOf(DataScheme scheme,
                                    String spec)

Creates SymbolStriper from the given specification for the given scheme, or throws exception.

Parameters:

scheme - data scheme

spec - striper specification

Returns:

non-null striper

Throws:

FilterSyntaxException - if spec is invalid or unknown