public enum RowCountStatus extends java.lang.Enum<RowCountStatus> implements ValueEnum
ResultSet.getRowCount() row count for the data set. This is a feature associated with progressive loading of data. When progressive loading is
active, the length may not indicate the true size of the data set.
In this case a different total row count may be maintained by the ResultSet data object and retrieved via ResultSet.getRowCount(). This status code indicates whether this row
count is an exact value or not.
| Enum Constant and Description |
|---|
APPROXIMATE
The current row count is an approximation.
|
EXACT
The size of the data set is known and the current row count is accurate.
|
LOADING
This value indicates that the ResultSet is waiting for an active
row count fetch to complete. |
MAXIMUM
The current row count is a maximum - there are no more than this many records in the data set.
|
MINIMUM
The current row count is a minimum - there are at least this many records in the data set.
|
RANGE
The data object knows the total number of records in the data set lies within a particular range.
|
UNKNOWN
The current row count is unknown.
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getValue() |
static RowCountStatus |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static RowCountStatus[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final RowCountStatus EXACT
progressiveLoading is not active. If progressiveLoading is
active, we may have an accurate row count in the following scenarios: ResultSet.setFullLength() was explicitly invoked to tell the resultSet
its total length.ResultSet.getLength() will
return the same value as ResultSet.getRowCount()ResultSet.getLength() will return the same
value as ResultSet.getRowCount()ResultSet.fetchRowCount().ResultSet.getLength() will return the same value as ResultSet.getRowCount() if ResultSet.applyRowCountToLength is true, otherwise the
values may differ.DSResponse.estimatedTotalRows value with an exact valueResultSet.getLength() will return the same value as
ResultSet.getRowCount() if ResultSet.applyRowCountToLength is true, otherwise the
values may differ.
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "exact".
public static final RowCountStatus UNKNOWN
ResultSet.lengthIsKnown() returns false.
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "unknown".
public static final RowCountStatus LOADING
row count fetch to complete.
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "loading".
public static final RowCountStatus MINIMUM
progressiveLoading is active, this will be the status if no
explicit DSResponse.estimatedTotalRows was available,
so DSResponse.totalRows is a minimum, or if DSResponse.estimatedTotalRows contained a value in the format
"[rowCount]+".
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "minimum".
public static final RowCountStatus APPROXIMATE
progressiveLoading is active and a fetch request contained an
explicit DSResponse.estimatedTotalRows in the format
"~[rowCount]".
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "approximate".
public static final RowCountStatus MAXIMUM
progressiveLoading is active and a fetch request
contained an explicit DSResponse.estimatedTotalRows in
the format "-[rowCount]".
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "maximum".
public static final RowCountStatus RANGE
ListGrid.getRowCountRange() may be used to retrieve the
upper and lower bound of this range, and ListGrid.getRowCount() will return the lower bound. This will be the status if progressiveLoading is active and a fetch request contained an
explicit DSResponse.estimatedTotalRows in the format
"[minRowCount]-[maxRowCount]".
If this enumerated value is used in a Component XML
file or server-side DataSource descriptor (.ds.xml file), use the value "range".
public static RowCountStatus[] values()
for (RowCountStatus c : RowCountStatus.values()) System.out.println(c);
public static RowCountStatus valueOf(java.lang.String name)
name - the name of the enum constant to be returned.java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null