Package net.ontopia.topicmaps.query.impl.basic

Class QueryResult

java.lang.Object

net.ontopia.topicmaps.query.impl.basic.QueryResult

All Implemented Interfaces:

AutoCloseable, QueryResultIF

public class QueryResult
extends Object
implements QueryResultIF

INTERNAL: The query result representation used by the basic implementation.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	current
protected int	last
protected QueryMatches	matches

Constructor Summary

Constructors

Constructor	Description
QueryResult(QueryMatches matches)
QueryResult(QueryMatches matches, int limit, int offset)

Method Summary

Modifier and Type	Method	Description
void	close()	PUBLIC: Closes the query result, which allows it to free its resources.
String	getColumnName(int ix)	PUBLIC: Returns the name of the given column.
String[]	getColumnNames()	PUBLIC: Returns the names of the columns.
int	getIndex(String colname)	PUBLIC: Returns the index of the named column.
Object	getValue(int ix)	PUBLIC: Returns the value in the given column in the current match.
Object	getValue(String colname)	PUBLIC: Returns the value in the given column in the current match.
Object[]	getValues()	PUBLIC: Returns the current match as an array of values.
Object[]	getValues(Object[] values)	PUBLIC: Reads the values of the current match into the specified array.
int	getWidth()	PUBLIC: Returns the number of columns in the result.
boolean	next()	PUBLIC: Steps to the next match, returning true if a valid match was found, and false if there are no more matches.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

matches

protected QueryMatches matches

current

protected int current

last

protected int last

Constructor Details

QueryResult

public QueryResult(QueryMatches matches)

QueryResult

public QueryResult(QueryMatches matches,
 int limit,
 int offset)

Method Details

next

public boolean next()

Description copied from interface: QueryResultIF

PUBLIC: Steps to the next match, returning true if a valid match was found, and false if there are no more matches. Must be called before values can be returned.

Specified by:

next in interface QueryResultIF

getValue

public Object getValue(int ix)

Description copied from interface: QueryResultIF

PUBLIC: Returns the value in the given column in the current match. The column index is zero-based. Requires next() to have been called first.

Specified by:

getValue in interface QueryResultIF

getValue

public Object getValue(String colname)

Description copied from interface: QueryResultIF

PUBLIC: Returns the value in the given column in the current match. Requires next() to have been called first.

Specified by:

getValue in interface QueryResultIF

getWidth

public int getWidth()

Description copied from interface: QueryResultIF

PUBLIC: Returns the number of columns in the result.

Specified by:

getWidth in interface QueryResultIF

getIndex

public int getIndex(String colname)

Description copied from interface: QueryResultIF

PUBLIC: Returns the index of the named column. Returns -1 if the column does not exist. The column index is zero-based.

Specified by:

getIndex in interface QueryResultIF

getColumnNames

public String[] getColumnNames()

Description copied from interface: QueryResultIF

PUBLIC: Returns the names of the columns.

Specified by:

getColumnNames in interface QueryResultIF

getColumnName

public String getColumnName(int ix)

Description copied from interface: QueryResultIF

PUBLIC: Returns the name of the given column. The column index is zero-based.

Specified by:

getColumnName in interface QueryResultIF

getValues

public Object[] getValues()

Description copied from interface: QueryResultIF

PUBLIC: Returns the current match as an array of values. Note that the returned array should not be modified as it may lead to undefined results. Requires next() to have been called first.

Specified by:

getValues in interface QueryResultIF

getValues

public Object[] getValues(Object[] values)

Description copied from interface: QueryResultIF

PUBLIC: Reads the values of the current match into the specified array. Requires next() to have been called first.

Specified by:

getValues in interface QueryResultIF

close

public void close()

Description copied from interface: QueryResultIF

PUBLIC: Closes the query result, which allows it to free its resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface QueryResultIF