Package ca.phon.query.db
Interface Result
- All Superinterfaces:
Iterable<ResultValue>
- All Known Implementing Classes:
XMLResult
Interface for the result of a Phon query.
-
Method Summary
Modifier and TypeMethodDescriptionint
addResultValue
(ResultValue resultValue) Add the given result value.Gets the map of metadata for this result.int
Get the number of result values.int
Gets the record index for this result.getResultValue
(int idx) Get the specified result valuegetResultValue
(String name) Get the result value by nameGets the schema of this result.boolean
Is this result excluded from reportsremoveResultValue
(int idx) Remove the specified result valuevoid
setExcluded
(boolean excluded) Set the excluded status of this result.void
setRecordIndex
(int index) Sets the record index for this result.void
Sets the schema of this result.Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
-
Method Details
-
getRecordIndex
int getRecordIndex()Gets the record index for this result.- Returns:
- the record index
-
setRecordIndex
void setRecordIndex(int index) Sets the record index for this result.- Parameters:
index
- the record index
-
getMetadata
Gets the map of metadata for this result.- Returns:
- the metadata map
-
getSchema
String getSchema()Gets the schema of this result.- Returns:
- the schema
-
setSchema
Sets the schema of this result.- Parameters:
schema
- the format
-
isExcluded
boolean isExcluded()Is this result excluded from reports- Returns:
true
if this result should be excludedfalse
otherwise.
-
setExcluded
void setExcluded(boolean excluded) Set the excluded status of this result.- Parameters:
excluded
-
-
getNumberOfResultValues
int getNumberOfResultValues()Get the number of result values.- Returns:
- number of result values
-
getResultValue
Get the result value by name- Parameters:
name
-- Returns:
- result value optional
-
getResultValue
Get the specified result value- Parameters:
idx
-- Returns:
- result value
- Throws:
ArrayIndexOutOfBoundsException
-
removeResultValue
Remove the specified result value- Parameters:
idx
-- Returns:
- the removed result value
-
addResultValue
Add the given result value.- Parameters:
resultValue
-- Returns:
- index of added result value
-