org.alfresco.service.cmr.search

Interface ResultSetSPI

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void close()
      Close the result set and release any resources held/ The result set is bound to the transaction and will auto close at the end of the transaction.
      boolean getBulkFetch()
      Do we bulk fetch
      int getBulkFetchSize()
      Get the bulk fetch size.
      ChildAssociationRef getChildAssocRef(int n)
      Get the child assoc ref for a particular row.
      java.util.List getChildAssocRefs()
      Get a list of all the child associations in the results set.
      java.util.List getFieldFacet(java.lang.String field) 
      NodeRef getNodeRef(int n)
      Get the id of the node at the given index (if there is only one selector or no selector)
      java.util.List getNodeRefs()
      Get a list of all the node refs in the result set (if there is only one selector or no selector)
      long getNumberFound()
      Get the number of rows that matched the query.
      ResultSetMetaData getResultSetMetaData()
      Get the meta data for the results set.
      ResultSetRow getRow(int i)
      Get a row from the result set by row index, starting at 0.
      float getScore(int n)
      Get the score for the node at the given position (if there is only one selector or no selector)
      int getStart()
      Get the start point for this results set in the overall set of rows that match the query - this will be equal to the skip count set when executing the query, and zero if this is not set.
      boolean hasMore()
      Was this result set curtailed - are there more pages to the result set?
      int length()
      Get the number of rows in this result set.
      boolean setBulkFetch(boolean bulkFetch)
      Bulk fetch results in the cache
      int setBulkFetchSize(int bulkFetchSize)
      Set the bulk fetch size
      • Methods inherited from interface java.lang.Iterable

        iterator
    • Method Detail

      • length

        int length()
        Get the number of rows in this result set. This will be less than or equal to the maximum number of rows requested or the full length of the results set if no restriction on length are specified. If a skip count is given, the length represents the number of results after the skip count and does not include the items skipped.
        Returns:
        the number of results. -1 means unknown and can be returned for lazy evaluations of permissions when the actual size is not known and evaluated upon request.
      • getNumberFound

        long getNumberFound()
        Get the number of rows that matched the query. This result set may only contain a section of the results. If a skip count is given the number found may or may not include the items skipped.
        Returns:
      • getNodeRef

        NodeRef getNodeRef(int n)
        Get the id of the node at the given index (if there is only one selector or no selector)
        Parameters:
        n - zero-based index
        Returns:
        return the the node ref for the row if there is only one selector
        Throws:
        AmbiguousSelectorException
      • getScore

        float getScore(int n)
        Get the score for the node at the given position (if there is only one selector or no selector)
        Parameters:
        n - zero-based index
        Returns:
        return the score for the row if there is only one selector
        Throws:
        AmbiguousSelectorException
      • close

        void close()
        Close the result set and release any resources held/ The result set is bound to the transaction and will auto close at the end of the transaction.
      • getRow

        ResultSetRow getRow(int i)
        Get a row from the result set by row index, starting at 0.
        Parameters:
        i - zero-based index
        Returns:
        return the row
      • getNodeRefs

        java.util.List getNodeRefs()
        Get a list of all the node refs in the result set (if there is only one selector or no selector)
        Returns:
        the node refs if there is only one selector or no selector *
        Throws:
        AmbiguousSelectorException
      • getChildAssocRefs

        java.util.List getChildAssocRefs()
        Get a list of all the child associations in the results set. (if there is only one selectoror no selector)
        Returns:
        the child assoc refs if there is only one selector or no selector *
        Throws:
        AmbiguousSelectorException
      • getChildAssocRef

        ChildAssociationRef getChildAssocRef(int n)
        Get the child assoc ref for a particular row. (if there is only one selectoror no selector)
        Parameters:
        n - zero-based index
        Returns:
        the child assoc ref for the row if there is only one selector or no selector
      • getResultSetMetaData

        ResultSetMetaData getResultSetMetaData()
        Get the meta data for the results set.
        Returns:
        the metadata
      • getStart

        int getStart()
        Get the start point for this results set in the overall set of rows that match the query - this will be equal to the skip count set when executing the query, and zero if this is not set.
        Returns:
        the position of the first result in the overall result set
      • hasMore

        boolean hasMore()
        Was this result set curtailed - are there more pages to the result set?
        Returns:
        true if there are more pages in the result set
      • setBulkFetch

        boolean setBulkFetch(boolean bulkFetch)
        Bulk fetch results in the cache
        Parameters:
        bulkFetch -
      • getBulkFetch

        boolean getBulkFetch()
        Do we bulk fetch
        Returns:
        - true if we do
      • setBulkFetchSize

        int setBulkFetchSize(int bulkFetchSize)
        Set the bulk fetch size
        Parameters:
        bulkFetchSize -
      • getBulkFetchSize

        int getBulkFetchSize()
        Get the bulk fetch size.
        Returns:
        the fetch size
      • getFieldFacet

        java.util.List getFieldFacet(java.lang.String field)
        Parameters:
        field -
        Returns:

Copyright © 2005 - 2013 Alfresco Software, Inc. All Rights Reserved.