Elexis API documentation
Version 2.1.6 as of December 11 2011

com.healthmarketscience.jackcess
Class RowId

java.lang.Object
  extended by com.healthmarketscience.jackcess.RowId
All Implemented Interfaces:
java.lang.Comparable<RowId>

public class RowId
extends java.lang.Object
implements java.lang.Comparable<RowId>

Uniquely identifies a row of data within the access database.

Author:
James Ahlborn

Nested Class Summary
static class RowId.Type
          type attributes for RowIds which simplify comparisons
 
Field Summary
static int FIRST_PAGE_NUMBER
          special page number which will sort before any other valid page number
static RowId FIRST_ROW_ID
          special rowId which will sort before any other valid rowId
static int INVALID_ROW_NUMBER
          special row number representing an invalid row number
static int LAST_PAGE_NUMBER
          special page number which will sort after any other valid page number
static RowId LAST_ROW_ID
          special rowId which will sort after any other valid rowId
 
Constructor Summary
RowId(int pageNumber, int rowNumber)
          Creates a new RowId instance.
 
Method Summary
 int compareTo(RowId other)
           
 boolean equals(java.lang.Object o)
           
 int getPageNumber()
           
 int getRowNumber()
           
 RowId.Type getType()
           
 int hashCode()
           
 boolean isValid()
          Returns true if this rowId potentially represents an actual row of data, false otherwise.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

FIRST_PAGE_NUMBER

public static final int FIRST_PAGE_NUMBER
special page number which will sort before any other valid page number

See Also:
Constant Field Values

LAST_PAGE_NUMBER

public static final int LAST_PAGE_NUMBER
special page number which will sort after any other valid page number

See Also:
Constant Field Values

INVALID_ROW_NUMBER

public static final int INVALID_ROW_NUMBER
special row number representing an invalid row number

See Also:
Constant Field Values

FIRST_ROW_ID

public static final RowId FIRST_ROW_ID
special rowId which will sort before any other valid rowId


LAST_ROW_ID

public static final RowId LAST_ROW_ID
special rowId which will sort after any other valid rowId

Constructor Detail

RowId

public RowId(int pageNumber,
             int rowNumber)
Creates a new RowId instance.

Method Detail

getPageNumber

public int getPageNumber()

getRowNumber

public int getRowNumber()

isValid

public boolean isValid()
Returns true if this rowId potentially represents an actual row of data, false otherwise.


getType

public RowId.Type getType()

compareTo

public int compareTo(RowId other)
Specified by:
compareTo in interface java.lang.Comparable<RowId>

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Elexis API documentation
Version 2.1.6 as of December 11 2011

Copyright 2005-2011 by Gerry Weirich, Elexis