Package com.cbe

Class QueryChain

  • public class QueryChain
extends java.lang.Object
    Class QueryChain. API call to query returns a QueryChain object that can call join on a query. ex: QueryChain qChain = container.query(itemDelegate).join(otherContainer, key1, key2, filter, container);

    • Constructor Summary

      Constructors 
      Constructor Description
      QueryChain()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      QueryResult getQueryResult()
      Returns the QueryResult from the join.
      QueryChain join​(Container containerToQuery, java.lang.String key1, java.lang.String key2)
      Performs a join requet in conjunction with a query to get related items from another container.
      QueryChain join​(Container containerToQuery, java.lang.String key1, java.lang.String key2, Container containerForResults)
      Performs a join requet in conjunction with a query using items in another container to adjust
      results.
      QueryChain join​(Container containerToQuery, java.lang.String key1, java.lang.String key2, Container containerForResults, ItemEventProtocol delegate)
      Performs a join requet in conjunction with a query using items in another container to adjust
      results.
      QueryChain join​(Container containerToQuery, java.lang.String key1, java.lang.String key2, Filter constraints)
      Performs a join requet in conjunction with a query to get related items from another container
      with additional constraints.
      QueryChain join​(Container containerToQuery, java.lang.String key1, java.lang.String key2, Filter constraints, Container containerForResults)
      Performs a join requet in conjunction with a query to adjust resluts with additional constraints
      on the joined container.If chained with a query or other joins the delegate will be called once
      with the complete joined query result.
      QueryChain join​(Container containerToQuery, java.lang.String key1, java.lang.String key2, Filter constraints, Container containerForResults, ItemEventProtocol delegate)
      Performs a join requet in conjunction with a query to adjust resluts with additional constraints
      on the joined container.If chained with a query or other joins the delegate will be called once
      with the complete joined query result.
      QueryChain join​(Container containerToQuery, java.lang.String key1, java.lang.String key2, Filter constraints, ItemEventProtocol delegate)
      Performs a join requet in conjunction with a query to get related items from another container
      with additional constraints.
      QueryChain join​(Container containerToQuery, java.lang.String key1, java.lang.String key2, ItemEventProtocol delegate)
      Performs a join requet in conjunction with a query to get related items from another container.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • QueryChain

        public QueryChain()

    • Method Detail

      • join

        public QueryChain join​(Container containerToQuery,
                       java.lang.String key1,
                       java.lang.String key2,
                       ItemEventProtocol delegate)
        Performs a join requet in conjunction with a query to get related items from another container. If chained with a query or other joins the delegate will be called once with the complete joined query result.
        Parameters:
        containerToQuery - : The container the join should be done with.
        key1 - : The key from the previous query on which to perform the join.
        key2 - : The key on objects in containerToQuery on which to perform the join
        delegate - : If this is null and join is chained with query the delegate from the query will be used. If join is called on a querychain where a query has completed a delegate should be passed in to the final join in the chain.

      • join

        public QueryChain join​(Container containerToQuery,
                       java.lang.String key1,
                       java.lang.String key2)
        Performs a join requet in conjunction with a query to get related items from another container. If chained with a query or other joins the delegate will be called once with the complete joined query result.
        Parameters:
        containerToQuery - : The container the join should be done with.
        key1 - : The key from the previous query on which to perform the join.
        key2 - : The key on objects in containerToQuery on which to perform the join

      • join

        public QueryChain join​(Container containerToQuery,
                       java.lang.String key1,
                       java.lang.String key2,
                       Filter constraints,
                       ItemEventProtocol delegate)
        Performs a join requet in conjunction with a query to get related items from another container
        with additional constraints. If chained with a query or other joins the delegate will be called
        once with the complete joined query result.
        Parameters:
        containerToQuery - : The container the join should be done with.
        key1 - : The key from the previous query on which to perform the join.
        key2 - : The key on objects in containerToQuery on which to perform the join
        constraints - : A filter that provides any constraints for the query.
        delegate - : If this is null and join is chained with query the delegate from the query will
        be used. If join is called on a querychain where a query has completed a delegate should be passed
        in to the final join in the chain.
        \

      • join

        public QueryChain join​(Container containerToQuery,
                       java.lang.String key1,
                       java.lang.String key2,
                       Filter constraints)
        Performs a join requet in conjunction with a query to get related items from another container
        with additional constraints. If chained with a query or other joins the delegate will be called
        once with the complete joined query result.
        Parameters:
        containerToQuery - : The container the join should be done with.
        key1 - : The key from the previous query on which to perform the join.
        key2 - : The key on objects in containerToQuery on which to perform the join
        constraints - : A filter that provides any constraints for the query.

      • join

        public QueryChain join​(Container containerToQuery,
                       java.lang.String key1,
                       java.lang.String key2,
                       Container containerForResults,
                       ItemEventProtocol delegate)
        Performs a join requet in conjunction with a query using items in another container to adjust
        results. If chained with a query or other joins the delegate will be called once with the
        complete joined query result.
        Parameters:
        containerToQuery - : The container the join should be done with.
        key1 - : The key from the previous query on which to perform the join.
        key2 - : The key on objects in containerToQuery on which to perform the join
        containerForResults - : Can be the conainer from the previous query if desired items should
        be from that container.
        delegate - : If this is null and join is chained with query the delegate from the query will
        be used. If join is called on a querychain where a query has completed a delegate should be
        passed in to the final join in the chain.

      • join

        public QueryChain join​(Container containerToQuery,
                       java.lang.String key1,
                       java.lang.String key2,
                       Container containerForResults)
        Performs a join requet in conjunction with a query using items in another container to adjust
        results. If chained with a query or other joins the delegate will be called once with the
        complete joined query result.
        Parameters:
        containerToQuery - : The container the join should be done with.
        key1 - : The key from the previous query on which to perform the join.
        key2 - : The key on objects in containerToQuery on which to perform the join
        containerForResults - : Can be the conainer from the previous query if desired items should
        be from that container.

      • join

        public QueryChain join​(Container containerToQuery,
                       java.lang.String key1,
                       java.lang.String key2,
                       Filter constraints,
                       Container containerForResults,
                       ItemEventProtocol delegate)
        Performs a join requet in conjunction with a query to adjust resluts with additional constraints
        on the joined container.If chained with a query or other joins the delegate will be called once
        with the complete joined query result.
        Parameters:
        containerToQuery - : The container the join should be done with.
        key1 - : The key from the previous query on which to perform the join.
        key2 - : The key on objects in containerToQuery on which to perform the join
        constraints - : A filter that provides any constraints for the query.
        containerForResults - : Can be the conainer from the previous query if desired items should
        be from that container.
        delegate - : If this is null and join is chained with query the delegate from the query will
        be used. If join is called on a querychain where a query has completed a delegate should be
        passed in to the final join in the chain.

      • join

        public QueryChain join​(Container containerToQuery,
                       java.lang.String key1,
                       java.lang.String key2,
                       Filter constraints,
                       Container containerForResults)
        Performs a join requet in conjunction with a query to adjust resluts with additional constraints
        on the joined container.If chained with a query or other joins the delegate will be called once
        with the complete joined query result.
        Parameters:
        containerToQuery - : The container the join should be done with.
        key1 - : The key from the previous query on which to perform the join.
        key2 - : The key on objects in containerToQuery on which to perform the join
        constraints - : A filter that provides any constraints for the query.
        containerForResults - : Can be the conainer from the previous query if desired items should
        be from that container.

      • getQueryResult

        public QueryResult getQueryResult()
        Returns the QueryResult from the join.