org.ametys.plugins.externaldata.data

Interface QueryResult

All Superinterfaces:

Iterable<QueryResultRow>

All Known Implementing Classes:

LazySqlQueryResult, LdapQueryResult, SqlQueryResult

public interface QueryResult
extends Iterable<QueryResultRow>

Result of a Query. Can be either single (should have one column and one row), or multiple (one or more columns, one or more rows).

Method Summary

Modifier and Type	Method and Description
void	close() Close and cleanup the underlying objects and resources (resultset if SQL, LDAP resources...) if needed.
Collection<String>	getColumnNames() Get the column names.
int	getSize() Get size
Query.ResultType	getType() Get the type of the result.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getType

Query.ResultType getType()

Get the type of the result.

Returns:

the result type.

getSize

int getSize()

Get size

Returns:

the size

getColumnNames

Collection<String> getColumnNames()
                           throws DataInclusionException

Get the column names.

Returns:

the column names as a Collection.

Throws:

DataInclusionException - if an error occurs while manipulating the data sources

close

void close()

Close and cleanup the underlying objects and resources (resultset if SQL, LDAP resources...) if needed.