com.legacyj.isam
Class ISAMKey

java.lang.Object
  |
  +--com.legacyj.isam.ISAMKey

All Implemented Interfaces:

ISAMConstants

public class ISAMKey

extends java.lang.Object

implements ISAMConstants

ISAMKey

Represents the data from the original two C structures keypart and keydesc, as referenced from keydesc:

  struct keypart                            // key component description
  {
      short kp_start;                       // offset within data record
      short kp_leng;                        // physical length
      short kp_type;                        // isam key type
  };

  struct keydesc                            // full key description
  {
      short k_flags;                        // key characteristics
      short k_nparts;                       // number of parts in key
      struct keypart k_part[ISMAXPARTS];    // description of each part
      short k_len;                          // complete key length
      long  k_rootnode;                     // root node record number
  }; 
 

ISAMJ Copyright 2000-2001 LegacyJ Corp. All Rights Reserved.

Field Summary

int	k_flags
int	k_len
int	k_nparts
long	k_rootnode
int[]	kp_leng
int[]	kp_start
int[]	kp_type

Fields inherited from interface com.legacyj.isam.ISAMConstants

AUDGETNAME, AUDHEADSIZE, AUDINFO, AUDSETNAME, AUDSTART, AUDSTOP, BYTEMASK, BYTESHFT, CHARSIZE, CHARTYPE, COLLATE1, COLLATE2, COLLATE3, COLLATE4, COLLATE5, COLLATE6, COLLATE7, COMPRESS, COMPRESS_O, DCOMPRESS, DECIMALTYPE, DOUBLESIZE, DOUBLETYPE, EARCHIVE, EAUDIT, EB_ARCH, EB_BUSY, EB_CHKNLOG, EB_DUPBS, EB_FULL, EB_IUBS, EB_NOBS, EB_NOCOL, EB_NOOPEN, EB_NOSUBSYS, EB_PAGE, EB_PSIZE, EB_SFULL, EB_STAMP, EBADARG, EBADCOLL, EBADFILE, EBADFORMAT, EBADKEY, EBADLOG, EBADMEM, EBADRMSG, EBADROWID, EBADSHMEM, EBADVCLEN, ECOL_SPEC, EDEADDEM, EDEADLOCK, EDEADTIME, EDEMO, EDISKMODE, EDUPL, EENDFILE, EEXPIRED, EFLOCKED, EFNAME, EGBLSECT, EINTERUPT, EKEXISTS, EKLOCKED, ELOCKED, ELOGOPEN, ELOGREAD, ELOGWRIT, ENEMPTY, ENLS_LANG, ENOBEGIN, ENOCLIENTS, ENOCONNECT, ENOCURR, ENODBS, ENOEXTN, ENOFREE, ENOLOCKS, ENOLOG, ENOLOK, ENOMANU, ENOMIRROR, ENONFS, ENOPARTN, ENOPRIM, ENOREC, ENOSHMEM, ENOSMI, ENOTEXCL, ENOTOPEN, ENOTRANS, EOYCHUNK, EOYDBS, EOYLOG, EOYPARTN, EOYPPAGE, EPMCHKBAD, EPRIMKEY, EROWSIZE, ES_ICONFIG, ES_IILLVAL, ES_ILLBUFF, ES_ILLFILE, ES_ILLLCKS, ES_ILLUSRS, ES_PROCDEFS, ES_SEMCTL, ES_SEMGET, ES_SHMCTL, ES_SHMGET, ETOOMANY, EUSER, FLOATSIZE, FLOATTYPE, IC_BADDATA, IC_BADMAGIC, IC_COUNT, IC_DATFREE, IC_DATREAD, IC_IDXREAD, IC_MATCH, IC_ORDER, ICLIENT, INTSIZE, INTTYPE, INVALID_ARGS, IO_AUD, IO_CREA, IO_DAT, IO_IDX, IO_IOCTL, IO_LCK, IO_LOCK, IO_LOG, IO_LOK, IO_OPEN, IO_READ, IO_SEEK, IO_SEM, IO_WRIT, IS_CREA, IS_IOCTL, IS_LOCK, IS_OPEN, IS_READ, IS_SEEK, IS_WRIT, ISADMIN, ISALL, ISAUDIT, ISAUTOLOCK, ISCISAM, ISCLOSED, ISCLUSTER, ISCURR, ISCUSTOM, ISDATAVOID, ISDECLARE, ISDESC, ISDUPLEN, ISDUPS, ISDYNAMIC, ISEQUAL, ISERRBASE, ISEXCLLOCK, ISEXCLLOCK_O, ISFIRST, ISFIXLEN, ISGREAT, ISGTEQ, ISHUGE, ISIDXBLK, ISINOUT, ISINPUT, ISIREADLOCK, ISISHARELOCK, ISIWRITELOCK, ISIZE, ISKEEPLOCK, ISKEEPLOCK_CISAM, ISLAST, ISLCKW, ISLKDEAD, ISLOCK, ISLOCKING, ISLOGGING, ISLONGID, ISLTYPMASK, ISMANULOCK, ISMASKED, ISMAXBUF, ISMAXIDX, ISMAXKEY, ISMAXOBJPC, ISMAXPARTS, ISMAXPARTS_O, ISNEXT, ISNOCARE, ISNOCASE, ISNOCHANGE, ISNODUPS, ISNOLOG, ISNONSPANNING, ISNORECOVER, ISNOWAIT, ISNOWAIT_O, ISOUTPUT, ISPREV, ISRDONLY, ISREADLOCK, ISRISHARE, ISRIWRITE, ISSHARELOCK, ISSIWRITE, ISSKIPLOCK, ISSKIPLOCK_C, ISSKIPLOCK_CISAM, ISSPANNING, ISSWRITE, ISSYNCWR, ISTRANS, ISUSERTYPESTART, ISVARCMP, ISVARIABLE, ISVARLEN, ISVARLEN_X, ISWAIT, ISWAIT_O, LCOMPRESS, LONGSIZE, LONGTYPE, MAXKEYSIZE, MAXKEYSIZE_O, MAXTYPE, MAXTYPE_X, MINTSIZE, MINTTYPE, MLONGSIZE, MLONGTYPE, NO_SUCH_FUNCTION, NPARTS, NULLKEY, STRINGSIZE, STRINGTYPE, SUCCESS, TCOMPRESS, TCOMPRESS_C, TCOMPRESS_O, TNULL, TYPEMASK, USERINFOSIZE, VARCHARSIZE, VARCHARTYPE, VAUDHEADSIZE

Constructor Summary

ISAMKey()

Method Summary

byte[]	getData() Gets the native byte array representation of the key fields.
int	getFlags() Gets key flags.
int	getLen() INTERNAL TO NATIVE CODE ONLY.
int	getLength(int index) Gets the length of the key part.
int	getParts() Gets the number of key parts.
long	getRootNode() INTERNAL TO NATIVE CODE ONLY.
int	getStart(int index) Gets the start of the key part.
int	getType(int index) Gets the type of the key part.
void	setData(byte[] data) Sets the key fields using the native representation in a byte[] array.
void	setFlags(int value) Sets key flags.
void	setLen(int value) INTERNAL TO NATIVE CODE ONLY.
void	setLength(int index, int value) Sets the length of the key part.
void	setParts(int value) Sets the number of key parts.
void	setRootNode(long value) INTERNAL TO NATIVE CODE ONLY.
void	setStart(int index, int value) Sets the start of the key part.
void	setType(int index, int value) Sets the type of the key part.

Methods inherited from class java.lang.Object

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

Field Detail

k_flags

public int k_flags

k_nparts

public int k_nparts

kp_start

public int[] kp_start

kp_leng

public int[] kp_leng

kp_type

public int[] kp_type

k_len

public int k_len

k_rootnode

public long k_rootnode

Constructor Detail

ISAMKey

public ISAMKey()

Method Detail

getData

public byte[] getData()

Gets the native byte array representation of the key fields.

Returns:

byte[] native array representation of the key fields

setData

public void setData(byte[] data)

Sets the key fields using the native representation in a byte[] array.

Parameters:

data - the native representation in a byte[] array

getFlags

public int getFlags()

Gets key flags.

Returns:

flags

setFlags

public void setFlags(int value)

Sets key flags.

Parameters:

value - the key flags

getParts

public int getParts()

Gets the number of key parts.

Returns:

number of key parts

setParts

public void setParts(int value)

Sets the number of key parts.

Parameters:

value - the number of key parts

getStart

public int getStart(int index)

Gets the start of the key part.

Parameters:

index - key part

Returns:

start of the indexed key part

setStart

public void setStart(int index,
                     int value)

Sets the start of the key part.

Parameters:

index - key part

value - start value

getLength

public int getLength(int index)

Gets the length of the key part.

Parameters:

index - key part

Returns:

length of the indexed key part

setLength

public void setLength(int index,
                      int value)

Sets the length of the key part.

Parameters:

index - key part

value - length of the indexed key part

getType

public int getType(int index)

Gets the type of the key part.

Parameters:

index - key part

Returns:

type of the key part.

setType

public void setType(int index,
                    int value)

Sets the type of the key part.

Parameters:

index - key part

getLen

public int getLen()

INTERNAL TO NATIVE CODE ONLY. Gets the key length in parts.

Returns:

k_len the key length in parts.

setLen

public void setLen(int value)

INTERNAL TO NATIVE CODE ONLY. Sets the key length in parts.

Parameters:

value - the key length in parts

getRootNode

public long getRootNode()

INTERNAL TO NATIVE CODE ONLY. Gets the root node

Returns:

long the root node

setRootNode

public void setRootNode(long value)

INTERNAL TO NATIVE CODE ONLY. Sets the root node

Parameters:

value - the root node