Interface Result

All Superinterfaces:
Iterable<ResultValue>
All Known Implementing Classes:
XMLResult
public interface Result extends Iterable<ResultValue>
Interface for the result of a Phon query.

  • 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

      Map<String,String> 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

      void setSchema(String schema)
      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 excluded false 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

      Optional<ResultValue> getResultValue(String name)
      Get the result value by name, this will return the first result value for the given name if there are multiple.
      Parameters:
      name -
      Returns:
      result value optional

    • getResultValues

      List<ResultValue> getResultValues(String name)
      Get all result values for the given name
      Parameters:
      name -
      Returns:
      list of result values for given name

    • getResultValue

      ResultValue getResultValue(int idx)
      Get the specified result value
      Parameters:
      idx -
      Returns:
      result value
      Throws:
      ArrayIndexOutOfBoundsException

    • removeResultValue

      ResultValue removeResultValue(int idx)
      Remove the specified result value
      Parameters:
      idx -
      Returns:
      the removed result value

    • addResultValue

      int addResultValue(ResultValue resultValue)
      Add the given result value.
      Parameters:
      resultValue -
      Returns:
      index of added result value