com.marklogic.client.row

Interface RowSet<T>

Type Parameters:

T - the type for reading a row from the set

All Superinterfaces:

AutoCloseable, Closeable, Iterable<T>

public interface RowSet<T>
extends Iterable<T>, Closeable

A Row Set represents a set of rows produced by a plan and read from the database.

The parameterized type will be RowRecord when reading each row as a map and can be a JSON read handle when reading each row as a JSON document, or an XML read handle when reading each row as a XML document.

The parameterized type can also be a JSON or XML IO representation with a registered handle such as a Jackson JsonNode or an XML DOM Document.

Method Summary

Modifier and Type	Method and Description
String[]	getColumnNames() Identifies the columns in the row set.
String[]	getColumnTypes() Identifies the data types of the columns.
Stream<T>	stream() Streams each row in the set of rows.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.io.Closeable

close

Method Detail

getColumnNames

String[] getColumnNames()

Identifies the columns in the row set.

Returns:

The column names

getColumnTypes

String[] getColumnTypes()

Identifies the data types of the columns.

The array lists the data types only if the rows were requested with a RowManager configured by calling the setDatatypeStyle() method with RowSetPart.HEADER.

Note that setting the data type style to HEADER does not cast the values of the column. The actual data type of the column values may be different from the header data type if the column values are inconsistent.

Returns:

The column data types

stream

Stream<T> stream()

Streams each row in the set of rows.

Returns:

a stream for the set of rows read from the database