com.marklogic.client.row

Interface RowRecord

All Superinterfaces:

Map<String,Object>

public interface RowRecord
extends Map<String,Object>

A Row Record provides an extended, read-only map interface to the column values in a row.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RowRecord.ColumnKind Distinguishes an atomic value, a content structure such as a document or other node, and a null value.

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(PlanExprCol col) Gets the value of a column with an xs:boolean schema data type as a Java boolean primitive value.
boolean	getBoolean(String columnName) Gets the value of a column with an xs:boolean schema data type as a Java boolean primitive value.
byte	getByte(PlanExprCol col) Gets the value of a column with an xs:byte schema data type as a Java byte primitive value.
byte	getByte(String columnName) Gets the value of a column with an xs:byte schema data type as a Java byte primitive value.
<T extends AbstractReadHandle> T	getContent(PlanExprCol col, T contentHandle) Gets the content of a column with a document or other content node value.
<T extends AbstractReadHandle> T	getContent(String columnName, T contentHandle) Gets the content of a column with a document or other content node value.
<T> T	getContentAs(PlanExprCol col, Class<T> as) Gets the content of a column with a document or other content node value.
<T> T	getContentAs(String columnName, Class<T> as) Gets the content of a column with a document or other content node value.
Format	getContentFormat(PlanExprCol col) Identifies the format where a column has a document or other content node value in the row instead of an atomic value.
Format	getContentFormat(String columnName) Identifies the format where a column has a document or other content node value in the row instead of an atomic value.
String	getContentMimetype(PlanExprCol col) Identifies the format where a column has a document or other content node value in the row instead of an atomic value.
String	getContentMimetype(String columnName) Identifies the format where a column has a document or other content node value in the row instead of an atomic value.
String	getDatatype(PlanExprCol col) Identifies the server data type for a column.
String	getDatatype(String columnName) Identifies the server data type for a column.
double	getDouble(PlanExprCol col) Gets the value of a column with an xs:double schema data type as a Java double primitive value.
double	getDouble(String columnName) Gets the value of a column with an xs:double schema data type as a Java double primitive value.
float	getFloat(PlanExprCol col) Gets the value of a column with an xs:float schema data type as a Java float primitive value.
float	getFloat(String columnName) Gets the value of a column with an xs:float schema data type as a Java float primitive value.
int	getInt(PlanExprCol col) Gets the value of a column with an xs:int schema data type as a Java int primitive value.
int	getInt(String columnName) Gets the value of a column with an xs:int schema data type as a Java int primitive value.
RowRecord.ColumnKind	getKind(PlanExprCol col) Identifies whether the value of a column is an atomic value, a document or other content structure, or a null.
RowRecord.ColumnKind	getKind(String columnName) Identifies whether the value of a column is an atomic value, a document or other content structure, or a null.
long	getLong(PlanExprCol col) Gets the value of a column with an xs:long schema data type as a Java long primitive value.
long	getLong(String columnName) Gets the value of a column with an xs:long schema data type as a Java long primitive value.
short	getShort(PlanExprCol col) Gets the value of a column with an xs:short schema data type as a Java short primitive value.
short	getShort(String columnName) Gets the value of a column with an xs:short schema data type as a Java short primitive value.
String	getString(PlanExprCol col) Gets the value of a column with an xs:string schema data type as a Java String literal value.
String	getString(String columnName) Gets the value of a column with an xs:string schema data type as a Java String literal value.
<T extends XsAnyAtomicTypeVal> T	getValueAs(PlanExprCol col, Class<T> as) Gets the value of a column with an atomic schema data type.
<T extends XsAnyAtomicTypeVal> T	getValueAs(String columnName, Class<T> as) Gets the value of a column with an atomic schema data type.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getKind

RowRecord.ColumnKind getKind(String columnName)

Identifies whether the value of a column is an atomic value, a document or other content structure, or a null.

Parameters:

columnName - the name of the column

Returns:

the kind of value of the column in the row

getKind

RowRecord.ColumnKind getKind(PlanExprCol col)

Identifies whether the value of a column is an atomic value, a document or other content structure, or a null.

Parameters:

col - the column identifier

Returns:

the kind of value of the column in the row

getDatatype

String getDatatype(String columnName)

Identifies the server data type for a column. A column may have different data types in different rows.

For atomic values, the string is the lexical form of a QName with the conventional prefix for the type namespace, a separating colon, and the type local name as in xs:int or xs:dateTime.

For node values, the string has the node type as in array, document, element, or object.

Parameters:

columnName - the name of the column

Returns:

the server data type

getDatatype

String getDatatype(PlanExprCol col)

Identifies the server data type for a column.

Parameters:

col - the column identifier

Returns:

the server data type

getBoolean

boolean getBoolean(String columnName)

Gets the value of a column with an xs:boolean schema data type as a Java boolean primitive value.

Parameters:

columnName - the name of the column

Returns:

the boolean primitive for an xs:boolean column

getBoolean

boolean getBoolean(PlanExprCol col)

Gets the value of a column with an xs:boolean schema data type as a Java boolean primitive value.

Parameters:

col - the column identifier

Returns:

the boolean primitive for an xs:boolean column

getByte

byte getByte(String columnName)

Gets the value of a column with an xs:byte schema data type as a Java byte primitive value.

Parameters:

columnName - the name of the column

Returns:

the byte primitive for an xs:byte column

getByte

byte getByte(PlanExprCol col)

Gets the value of a column with an xs:byte schema data type as a Java byte primitive value.

Parameters:

col - the column identifier

Returns:

the byte primitive for an xs:byte column

getDouble

double getDouble(String columnName)

Gets the value of a column with an xs:double schema data type as a Java double primitive value.

Parameters:

columnName - the name of the column

Returns:

the double primitive for an xs:double column

getDouble

double getDouble(PlanExprCol col)

Gets the value of a column with an xs:double schema data type as a Java double primitive value.

Parameters:

col - the column identifier

Returns:

the double primitive for an xs:double column

getFloat

float getFloat(String columnName)

Gets the value of a column with an xs:float schema data type as a Java float primitive value.

Parameters:

columnName - the name of the column

Returns:

the float primitive for an xs:float column

getFloat

float getFloat(PlanExprCol col)

Gets the value of a column with an xs:float schema data type as a Java float primitive value.

Parameters:

col - the column identifier

Returns:

the float primitive for an xs:float column

getInt

int getInt(String columnName)

Gets the value of a column with an xs:int schema data type as a Java int primitive value.

Parameters:

columnName - the name of the column

Returns:

the int primitive for an xs:int column

getInt

int getInt(PlanExprCol col)

Gets the value of a column with an xs:int schema data type as a Java int primitive value.

Parameters:

col - the column identifier

Returns:

the int primitive for an xs:int column

getLong

long getLong(String columnName)

Gets the value of a column with an xs:long schema data type as a Java long primitive value.

Parameters:

columnName - the name of the column

Returns:

the long primitive for an xs:long column

getLong

long getLong(PlanExprCol col)

Gets the value of a column with an xs:long schema data type as a Java long primitive value.

Parameters:

col - the column identifier

Returns:

the long primitive for an xs:long column

getShort

short getShort(String columnName)

Gets the value of a column with an xs:short schema data type as a Java short primitive value.

Parameters:

columnName - the name of the column

Returns:

the short primitive for an xs:short column

getShort

short getShort(PlanExprCol col)

Gets the value of a column with an xs:short schema data type as a Java short primitive value.

Parameters:

col - the column identifier

Returns:

the short primitive for an xs:short column

getString

String getString(String columnName)

Gets the value of a column with an xs:string schema data type as a Java String literal value.

Parameters:

columnName - the name of the column

Returns:

the String literal for an xs:string column

getString

String getString(PlanExprCol col)

Gets the value of a column with an xs:string schema data type as a Java String literal value.

Parameters:

col - the column identifier

Returns:

the String literal for an xs:string column

getValueAs

<T extends XsAnyAtomicTypeVal> T getValueAs(String columnName,
                                            Class<T> as)

Gets the value of a column with an atomic schema data type.

The value class must have the same schema data type as the value of the column in the row.

Type Parameters:

T - the type of the object for the value

Parameters:

columnName - the name of the column

as - the value class for the schema data type of the column

Returns:

an object of the class with the value of the data type

getValueAs

<T extends XsAnyAtomicTypeVal> T getValueAs(PlanExprCol col,
                                            Class<T> as)

Gets the value of a column with an atomic schema data type.

Type Parameters:

T - the type of the object for the value

Parameters:

col - the column identifier

as - the value class for the schema data type of the column

Returns:

an object of the class with the value of the data type

getContentFormat

Format getContentFormat(String columnName)

Identifies the format where a column has a document or other content node value in the row instead of an atomic value.

Parameters:

columnName - the name of the column

Returns:

the format of the column content

getContentFormat

Format getContentFormat(PlanExprCol col)

Identifies the format where a column has a document or other content node value in the row instead of an atomic value.

Parameters:

col - the column identifier

Returns:

the format of the column content

getContentMimetype

String getContentMimetype(String columnName)

Identifies the format where a column has a document or other content node value in the row instead of an atomic value.

Parameters:

columnName - the name of the column

Returns:

the mimetype of the column content

getContentMimetype

String getContentMimetype(PlanExprCol col)

Identifies the format where a column has a document or other content node value in the row instead of an atomic value.

Parameters:

col - the column identifier

Returns:

the mimetype of the column content

getContent

<T extends AbstractReadHandle> T getContent(String columnName,
                                            T contentHandle)

Gets the content of a column with a document or other content node value.

The handle must support IO for content with the format and mimetype. For instance, an XML DOM handle cannot be used to read a JSON document.

Type Parameters:

T - the type of the handle for reading the content

Parameters:

columnName - the name of the column

contentHandle - a handle for reading the content of the column value

Returns:

the content handle populated with the content of the column value

getContent

<T extends AbstractReadHandle> T getContent(PlanExprCol col,
                                            T contentHandle)

Gets the content of a column with a document or other content node value.

Type Parameters:

T - the type of the handle for reading the content

Parameters:

col - the column identifier

contentHandle - a handle for reading the content of the column value

Returns:

the content handle populated with the content of the column value

getContentAs

<T> T getContentAs(String columnName,
                   Class<T> as)

Gets the content of a column with a document or other content node value.

The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered.

Learn more about shortcut methods

Type Parameters:

T - the type of the IO object for the content

Parameters:

columnName - the name of the column

as - the IO class for reading the content of the column value

Returns:

an object of the IO class with the content of the column value

getContentAs

<T> T getContentAs(PlanExprCol col,
                   Class<T> as)

Gets the content of a column with a document or other content node value.

Type Parameters:

T - the type of the IO object for the content

Parameters:

col - the column identifier

as - the IO class for reading the content of the column value

Returns:

an object of the IO class with the content of the column value