com.devexperts.qd.kit

Class RangeStriper

java.lang.Object

com.devexperts.qd.kit.RangeStriper

All Implemented Interfaces:

SymbolStriper

public class RangeStriper
extends Object
implements SymbolStriper

Strategy that splits symbol universe into stripes by range boundaries.

Example: striper byrange-D-M- splits the symbol universe into 3 stripes described by filters: range--D-, range-D-M-, range-M--.

RangeStriper can be matched by the following regex: byrange-(?:([a-zA-Z0-9]{1,8})-)+, where each group represents a stripe boundary. For performance reasons stripe boundaries must not be greater than 8 characters long.

See Also:

RangeFilter

Field Summary

Fields

Modifier and Type	Field and Description
protected SymbolCodec	codec
protected int	codeLength
protected RangeFilter[]	filters
protected String	name
protected static int	PREFIX_LENGTH
static String	RANGE_STRIPER_PREFIX
protected long[]	rangeCodes
protected String[]	ranges
protected DataScheme	scheme
protected int	stripeCount
protected int	wildcard

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RangeStriper(DataScheme scheme, String[] ranges, String spec)

Method Summary

Modifier and Type	Method and Description
BitSet	getIntersectingStripes(QDFilter filter) Returns bit set of SymbolStriper.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.
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.
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.
protected static void	validateRange(int rangeIndex, String range)
protected static int	validateRanges(String[] ranges)
static SymbolStriper	valueOf(DataScheme scheme, List<String> ranges) Constructs a symbol striper for a given array of symbol ranges.
static RangeStriper	valueOf(DataScheme scheme, String spec) Parses a given specification as range striper for a given scheme.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.devexperts.qd.SymbolStriper

definedValueOf

Field Detail

RANGE_STRIPER_PREFIX

public static final String RANGE_STRIPER_PREFIX

See Also:

Constant Field Values

PREFIX_LENGTH

protected static final int PREFIX_LENGTH

name

protected final String name

scheme

protected final DataScheme scheme

codec

protected final SymbolCodec codec

wildcard

protected final int wildcard

stripeCount

protected final int stripeCount

codeLength

protected final int codeLength

ranges

protected final String[] ranges

rangeCodes

protected final long[] rangeCodes

filters

protected final RangeFilter[] filters

Constructor Detail

RangeStriper

protected RangeStriper(DataScheme scheme,
                       String[] ranges,
                       String spec)

Method Detail

valueOf

public static RangeStriper valueOf(DataScheme scheme,
                                   String spec)

Parses a given specification as range striper for a given scheme.

Specified by:

valueOf in interface SymbolStriper

Parameters:

scheme - the scheme.

spec - the striper specification.

Returns:

symbol striper.

Throws:

NullPointerException - if spec is null.

FilterSyntaxException - if spec is invalid.

valueOf

public static SymbolStriper valueOf(DataScheme scheme,
                                    List<String> ranges)

Constructs a symbol striper for a given array of symbol ranges. Note that if the array is empty then MonoStriper.INSTANCE striper will be returned.

Parameters:

scheme - the scheme.

ranges - the list of range boundaries.

Returns:

symbol striper.

Throws:

NullPointerException - if spec is null.

FilterSyntaxException - if spec is invalid.

getName

public String getName()

Description copied from interface: SymbolStriper

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

Specified by:

getName in interface SymbolStriper

getStripeCount

public int getStripeCount()

Description copied from interface: SymbolStriper

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

Specified by:

getStripeCount in interface SymbolStriper

Returns:

number of stripes (must be positive)

toString

public String toString()

Description copied from interface: SymbolStriper

Returns a string representation of this striper.

Specified by:

toString in interface SymbolStriper

Overrides:

toString in class Object

See Also:

SymbolStriper.getName()

getScheme

public DataScheme getScheme()

Description copied from interface: SymbolStriper

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

Specified by:

getScheme in interface SymbolStriper

getStripeIndex

public int getStripeIndex(int cipher,
                          String symbol)

Description copied from interface: SymbolStriper

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.

Specified by:

getStripeIndex in interface SymbolStriper

Parameters:

cipher - symbol cipher

symbol - symbol string

Returns:

stripe index

See Also:

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

getStripeIndex

public int getStripeIndex(String symbol)

Description copied from interface: SymbolStriper

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

Specified by:

getStripeIndex in interface SymbolStriper

Parameters:

symbol - symbol string (not-null)

Returns:

stripe index

See Also:

SymbolStriper.getStripeIndex(int, String)

getStripeIndex

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

Description copied from interface: SymbolStriper

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

Specified by:

getStripeIndex in interface SymbolStriper

Parameters:

symbol - array that is the source of the symbol

offset - the initial offset

length - the symbol's length

Returns:

stripe index

See Also:

SymbolStriper.getStripeIndex(int, String)

getIntersectingStripes

public BitSet getIntersectingStripes(QDFilter filter)

Description copied from interface: SymbolStriper

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

Specified by:

getIntersectingStripes in interface SymbolStriper

Parameters:

filter - QD filter to check for intersection

Returns:

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

getStripeFilter

public QDFilter getStripeFilter(int stripeIndex)

Description copied from interface: SymbolStriper

Returns filter corresponding for the given stripe index.

Specified by:

getStripeFilter in interface SymbolStriper

Parameters:

stripeIndex - stripe index

Returns:

QD filter for the stripe

validateRanges

protected static int validateRanges(String[] ranges)

validateRange

protected static void validateRange(int rangeIndex,
                                    String range)