|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Immutable public static interface QueryResults.Columns
Definition of the columns that are available in the results, which outline the structure of the
tuples
in the results, and which can be used to access the individual values in each of
the tuples.
Method Summary | |
---|---|
int |
getColumnCount()
Get the number of columns in each tuple. |
int |
getColumnIndexForName(String columnName)
Get the index of the column given the column name. |
int |
getColumnIndexForProperty(String selectorName,
String propertyName)
Get the index of the column given the name of the selector and the property name from where the column should be obtained. |
List<String> |
getColumnNames()
Get the names of the columns. |
List<Column> |
getColumns()
Get the columns. |
int |
getFullTextSearchScoreIndexFor(String selectorName)
Get the index of the tuple value containing the full-text search score for the node taken from the named selector. |
int |
getLocationCount()
Get the number of Location objects in each tuple. |
int |
getLocationIndex(String selectorName)
Get the index of a tuple's correct Location object given the name of the selector used in the query. |
int |
getLocationIndexForColumn(int columnIndex)
Get the index of a tuple's correct Location object given the column index. |
int |
getLocationIndexForColumn(String columnName)
Get the index of a tuple's correct Location object given the column index. |
String |
getPropertyNameForColumn(int columnIndex)
Get the name of the property that corresponds to the supplied column in each tuple. |
String |
getPropertyNameForColumn(String columnName)
Get the name of the property that corresponds to the supplied column in each tuple. |
List<String> |
getSelectorNames()
Get the names of the selectors that are associated with these results. |
int |
getTupleSize()
Get the size of the tuple arrays. |
List<String> |
getTupleValueNames()
Get the names of the all of the tuple values. |
boolean |
hasFullTextSearchScores()
Determine whether these results include full-text search scores. |
boolean |
hasSelector(String selectorName)
Determine if these results contain values from the selector with the supplied name. |
boolean |
includes(QueryResults.Columns other)
Determine whether this mapping includes all of the columns (and locations) in the supplied mapping. |
boolean |
isUnionCompatible(QueryResults.Columns other)
Determine whether this column and the other are union-compatible (that is, having the same columns). |
QueryResults.Columns |
subSelect(Column... columns)
Obtain a new definition for the query results that can be used to reference the same tuples that use this columns definition, but that defines a subset of the columns in this definition. |
QueryResults.Columns |
subSelect(List<Column> columns)
Obtain a new definition for the query results that can be used to reference the same tuples that use this columns definition, but that defines a subset of the columns in this definition. |
Method Detail |
---|
List<Column> getColumns()
getColumnCount()
; never nullList<String> getColumnNames()
getColumnCount()
; never nullint getColumnCount()
int getLocationCount()
Location
objects in each tuple.
List<String> getSelectorNames()
Location
object for each of the selectors.
getLocationCount()
; never nullint getTupleSize()
List<String> getTupleValueNames()
int getLocationIndexForColumn(int columnIndex)
columnIndex
- the column index
IndexOutOfBoundsException
- if the column index is invalidint getLocationIndexForColumn(String columnName)
columnName
- the column name
NoSuchElementException
- if the column name is invalidint getLocationIndex(String selectorName)
selectorName
- the selector name
NoSuchElementException
- if the selector name is invalidboolean hasSelector(String selectorName)
selectorName
- the selector name
String getPropertyNameForColumn(int columnIndex)
columnIndex
- the column index
IndexOutOfBoundsException
- if the column index is invalidString getPropertyNameForColumn(String columnName)
columnName
- the column name
NoSuchElementException
- if the column name is invalid or doesn't match an existing columnint getColumnIndexForName(String columnName)
columnName
- the column name
NoSuchElementException
- if the column name is invalid or doesn't match an existing columnint getColumnIndexForProperty(String selectorName, String propertyName)
selectorName
- the selector namepropertyName
- the name of the property
NoSuchElementException
- if the selector name or the property name are invalidint getFullTextSearchScoreIndexFor(String selectorName)
selectorName
- the selector name
Double
full-text search score, or -1 if there is no full-text search
score for the named selector
NoSuchElementException
- if the selector name is invalidboolean hasFullTextSearchScores()
boolean includes(QueryResults.Columns other)
other
- the other mapping; may not be null
boolean isUnionCompatible(QueryResults.Columns other)
other
- the other mapping; may not be null
QueryResults.Columns subSelect(List<Column> columns)
columns
- the new columns, which must be a subset of the columns in this definition; may not be null
QueryResults.Columns subSelect(Column... columns)
columns
- the new columns, which must be a subset of the columns in this definition; may not be null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |