com.basis.filesystem.util

Class KeySegment

java.lang.Object

com.basis.filesystem.util.KeySegment

All Implemented Interfaces:

java.io.Serializable

public final class KeySegment
extends java.lang.Object
implements java.io.Serializable

Class used to describe individual key segments of derived keys in MKEYED and XKEYED files.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SEGMENT_BUS
static int	SEGMENT_CASE_INSENSITIVE
static int	SEGMENT_NORMAL
static int	SEGMENT_ORDERED_NUMERIC

Constructor Summary

Constructors

Constructor and Description
KeySegment()
KeySegment(int p_fieldNumber, int p_offset, int p_length, boolean p_descending, boolean p_bus) Deprecated.
KeySegment(int p_fieldNumber, int p_offset, int p_length, boolean p_descending, int p_special) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object p_other)
int	getField() Get field.
int	getLength() Get length.
int	getOffset() Get offset.
int	getSpecialType() Get special type.
int	hashCode()
boolean	isBUS() Get bus.
boolean	isCaseInsensitive() Get case insensitive.
boolean	isDescending() Get descending.
boolean	isNormal() Is this segment normal.
boolean	isNumeric() Deprecated.
boolean	isOrderedNumeric() Get ordered numeric.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SEGMENT_NORMAL

public static final int SEGMENT_NORMAL

See Also:

Constant Field Values

SEGMENT_BUS

public static final int SEGMENT_BUS

See Also:

Constant Field Values

SEGMENT_ORDERED_NUMERIC

public static final int SEGMENT_ORDERED_NUMERIC

See Also:

Constant Field Values

SEGMENT_CASE_INSENSITIVE

public static final int SEGMENT_CASE_INSENSITIVE

See Also:

Constant Field Values

Constructor Detail

KeySegment

public KeySegment()

KeySegment

@Deprecated
public KeySegment(int p_fieldNumber,
                               int p_offset,
                               int p_length,
                               boolean p_descending,
                               boolean p_bus)
                        throws FilesystemException

Deprecated.

Constructor

Parameters:

p_fieldNumber - Number of field to start segment on -- start at beginning of record if 0.

p_offset - Offset within field to start at.

p_length - How many bytes the segment consists of.

p_descending - If true then segment is descending.

p_bus - If true the segment is an 8 byte business math value.

Throws:

FilesystemException - If a filesystem problem occurs.

KeySegment

public KeySegment(int p_fieldNumber,
                  int p_offset,
                  int p_length,
                  boolean p_descending,
                  int p_special)
           throws FilesystemException

Constructor

Parameters:

p_fieldNumber - Number of field to start segment on -- start at beginning of record if 0.

p_offset - Offset within field to start at.

p_length - How many bytes the segment consists of.

p_descending - If true then segment is descending.

p_special - Special segment type.

Throws:

FilesystemException - If a filesystem problem occurs.

Method Detail

equals

public boolean equals(java.lang.Object p_other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getSpecialType

public int getSpecialType()

Get special type.

Returns:

Special type.

getField

public int getField()

Get field.

Returns:

Field number.

getOffset

public int getOffset()

Get offset.

Returns:

Offset.

getLength

public int getLength()

Get length.

Returns:

Length.

isDescending

public boolean isDescending()

Get descending.

Returns:

true if segment is descending.

isBUS

public boolean isBUS()

Get bus.

Returns:

true if segment is numeric.

isNumeric

@Deprecated
public boolean isNumeric()

Deprecated.

Get bus. Deprecated method.

Returns:

true if segment is numeric.

isOrderedNumeric

public boolean isOrderedNumeric()

Get ordered numeric.

Returns:

true if segment is ordered numeric.

isCaseInsensitive

public boolean isCaseInsensitive()

Get case insensitive.

Returns:

true if segment is ordered numeric.

isNormal

public boolean isNormal()

Is this segment normal.

Returns:

true if segment is normal.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object