public final class RowDescriptor extends java.lang.Object implements java.lang.Iterable<FieldDescriptor>
RowDescriptor is a java mapping of the XSQLDA server data structure used to describe the row
metadata of one row for input or output.
RowDescriptor is an immutable, values of a row are maintained separately in a RowValue.
| Modifier and Type | Method and Description |
|---|---|
RowValue |
createDefaultFieldValues()
Creates a
RowValue instance with default (null) values for each field. |
RowValue |
createDeletedRowMarker()
Creates a deleted row marker.
|
static RowDescriptor |
createRowDescriptor(FieldDescriptor[] fieldDescriptors,
DatatypeCoder datatypeCoder)
Creates an instance of
RowDescriptor with the supplied FieldDescriptor instances. |
static RowDescriptor |
empty(DatatypeCoder datatypeCoder)
Returns an empty row descriptor with the specified datatype coder.
|
boolean |
equals(java.lang.Object obj) |
int |
getCount() |
DatatypeCoder |
getDatatypeCoder() |
IEncodingFactory |
getEncodingFactory() |
FieldDescriptor |
getFieldDescriptor(int index)
Gets the
FieldDescriptor at the specified (0-based) index. |
java.util.List<FieldDescriptor> |
getFieldDescriptors() |
int |
hashCode() |
java.util.Iterator<FieldDescriptor> |
iterator() |
java.lang.String |
toString() |
public DatatypeCoder getDatatypeCoder()
DatatypeCoder.public IEncodingFactory getEncodingFactory()
IEncodingFactory.public int getCount()
public FieldDescriptor getFieldDescriptor(int index)
FieldDescriptor at the specified (0-based) index.index - 0-based index of the fieldjava.lang.IndexOutOfBoundsException - if index is not 0 <= index < getCountpublic java.util.List<FieldDescriptor> getFieldDescriptors()
FieldDescriptor instances of this row.public RowValue createDefaultFieldValues()
RowValue instance with default (null) values for each field.
All fields are marked as uninitialized.
The (0-based) index of the each field value in the RowValue corresponds with the (0-based) index of the
FieldDescriptor within this RowDescriptor.
RowValue instance for a row described by this descriptor.RowValue.defaultFor(RowDescriptor)public RowValue createDeletedRowMarker()
A deleted row marker is used in JDBC result sets for deleted rows, and to discern them from (updated) rows that
are simply all NULL. This is for Jaybird internal implementation needs only.
count number of rows, all set to nullpublic java.util.Iterator<FieldDescriptor> iterator()
iterator in interface java.lang.Iterable<FieldDescriptor>public java.lang.String toString()
toString in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic static RowDescriptor createRowDescriptor(FieldDescriptor[] fieldDescriptors, DatatypeCoder datatypeCoder)
RowDescriptor with the supplied FieldDescriptor instances.fieldDescriptors - The field descriptors (array is cloned before use)datatypeCoder - he datatype code for the connection that uses this RowDescriptor.RowDescriptor instancepublic static RowDescriptor empty(DatatypeCoder datatypeCoder)
datatypeCoder - The datatype code for the connection that uses this RowDescriptor.Copyright © 2001-2024 Jaybird (Firebird JDBC) team. All rights reserved.