Class Key

java.lang.Object
  |
  +--Key

All Implemented Interfaces:

java.io.Serializable

public class Key

extends java.lang.Object

implements java.io.Serializable

See Also:

Serialized Form

Field Summary

protected int	abbmask
protected int	abbshift
static int	abbsize
protected boolean	Constructed
protected int	rowmask
protected int	rowshift
static int	rowsize
static int	size
protected Database	TheSchema
protected int	value
protected int	vermask
protected int	vershift
static int	versize

Constructor Summary

Key(java.lang.String strval, Database mySchema)

Method Summary

int	compare(Key otherkey) Returns > 0 if the integer key value is greater than that of otherkey, Returns < 0 if the integer key value is less than that of otherkey, Returns 0 if the integer key value is equal to that of otherkey,
java.lang.String	getAbb() Retrieves the table abbreviation portion of the key
int	getRow() Retrieves the row number from the key
Database	getTheSchema() Retrieves a reference to the global schema
int	getValue() Returns the integer encoding for the key
int	getVersion() Retrieves the version bytes of the key
boolean	setAbb(java.lang.String ab) Sets the table abbreviation portion of the key
boolean	setRow(int r) Sets the row number of the key from its argument
void	setTheSchema(Database value) Modifies this object's reference to the global schema
boolean	setVersion(int r) Sets the version bytes of the key from its argument
java.lang.String	toString()
boolean	Valid() Returns true if this key was able to be built successfully.

Methods inherited from class java.lang.Object

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

Field Detail

value

protected int value

size

public static final int size

See Also:

Constant Field Values

versize

public static final int versize

See Also:

Constant Field Values

abbsize

public static final int abbsize

See Also:

Constant Field Values

rowsize

public static final int rowsize

See Also:

Constant Field Values

abbmask

protected final int abbmask

See Also:

Constant Field Values

abbshift

protected final int abbshift

See Also:

Constant Field Values

vermask

protected final int vermask

See Also:

Constant Field Values

vershift

protected final int vershift

See Also:

Constant Field Values

rowmask

protected final int rowmask

See Also:

Constant Field Values

rowshift

protected final int rowshift

See Also:

Constant Field Values

TheSchema

protected Database TheSchema

Constructed

protected boolean Constructed

Constructor Detail

Key

public Key(java.lang.String strval,
           Database mySchema)

Method Detail

Valid

public boolean Valid()

Returns true if this key was able to be built successfully. The usual cause for failure is if the table abbreviation found is invalid.

getValue

public int getValue()

Returns the integer encoding for the key

compare

public int compare(Key otherkey)

Returns > 0 if the integer key value is greater than that of otherkey, Returns < 0 if the integer key value is less than that of otherkey, Returns 0 if the integer key value is equal to that of otherkey,

setVersion

public boolean setVersion(int r)

Sets the version bytes of the key from its argument

getVersion

public int getVersion()

Retrieves the version bytes of the key

setRow

public boolean setRow(int r)

Sets the row number of the key from its argument

getRow

public int getRow()

Retrieves the row number from the key

setAbb

public boolean setAbb(java.lang.String ab)

Sets the table abbreviation portion of the key

getAbb

public java.lang.String getAbb()

Retrieves the table abbreviation portion of the key

getTheSchema

public Database getTheSchema()

Retrieves a reference to the global schema

setTheSchema

public void setTheSchema(Database value)

Modifies this object's reference to the global schema

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object