org.usergrid.persistence
Class Query

java.lang.Object
  extended by org.usergrid.persistence.Query

public class Query
extends Object


Nested Class Summary
static class Query.CounterFilterPredicate
           
static class Query.FilterOperator
           
static class Query.FilterPredicate
           
static class Query.SortDirection
           
static class Query.SortPredicate
           
 
Field Summary
protected  List<String> categories
           
protected  String connection
           
protected  List<Query.CounterFilterPredicate> counterFilters
           
protected  String cursor
           
static int DEFAULT_LIMIT
           
protected  Long finishTime
           
protected  List<Identifier> groups
           
protected  List<Identifier> identifiers
           
protected  Results.Level level
           
protected  int limit
           
protected  boolean limitSet
           
protected  boolean mergeSelectResults
           
protected  boolean pad
           
protected  List<String> permissions
           
protected  CounterResolution resolution
           
protected  boolean reversed
           
protected  boolean reversedSet
           
protected  Operand rootOperand
           
protected  Map<String,String> selectSubjects
           
protected  List<Query.SortPredicate> sortPredicates
           
protected  UUID startResult
           
protected  Long startTime
           
protected  String type
           
protected  List<Identifier> users
           
 
Constructor Summary
Query()
           
Query(Query q)
           
 
Method Summary
 void addCategory(String category)
           
 Query addContainsFilter(String propName, String keyword)
           
 void addCounterFilter(String counter)
           
 Query addEqualityFilter(String propName, Object value)
          Add a equal filter to this query.
 Query addFilter(String filter)
          Add the filter from a string
 Query addGreaterThanEqualFilter(String propName, Object value)
          Add a greater than equal filter to this query.
 Query addGreaterThanFilter(String propName, Object value)
          Add a less than filter to this query.
 void addGroup(Identifier group)
           
 void addIdentifier(Identifier identifier)
           
 Query addLessThanEqualFilter(String propName, Object value)
          Add a less than equal filter to this query.
 Query addLessThanFilter(String propName, Object value)
          Add a less than filter to this query.
 Query addLocationFilter(String propName, float distance, float lattitude, float longitude)
           
 Query addSelect(String select)
           
 Query addSelect(String select, String output)
           
 Query addSort(Query.SortPredicate sort)
           
 Query addSort(String propertyName)
           
 Query addSort(String propertyName, Query.SortDirection direction)
           
 void addUser(Identifier user)
           
 boolean containsNameOrEmailIdentifiersOnly()
           
 boolean containsSingleNameOrEmailIdentifier()
           
 boolean containsSingleUuidIdentifier()
           
 boolean containsUuidIdentifersOnly()
           
static Query findForProperty(String propertyName, Object propertyValue)
           
static Query fromEmail(String email)
           
static Query fromIdentifier(Object id)
           
static Query fromJsonString(String json)
           
static Query fromName(String name)
           
static Query fromQL(String ql)
           
static Query fromQueryParams(Map<String,List<String>> params)
           
static Query fromUUID(UUID uuid)
           
 List<String> getCategories()
           
 String getConnectionType()
           
 List<Query.CounterFilterPredicate> getCounterFilters()
           
 String getCursor()
           
 List<String> getEmailIdentifiers()
           
 String getEntityType()
           
 Long getFinishTime()
           
 List<Identifier> getGroups()
           
 List<Identifier> getIdentifiers()
           
 int getLimit()
           
 int getLimit(int defaultLimit)
           
 List<String> getNameAndEmailIdentifiers()
           
 List<String> getNameIdentifiers()
           
 List<String> getPermissions()
           
 CounterResolution getResolution()
           
 Results.Level getResultsLevel()
           
 Operand getRootOperand()
           
 Map<String,String> getSelectAssignments()
           
 Object getSelectionResult(Results rs)
           
 List<Object> getSelectionResults(Results rs)
           
 Set<String> getSelectSubjects()
           
 String getSingleNameOrEmailIdentifier()
           
 UUID getSingleUuidIdentifier()
           
 List<Query.SortPredicate> getSortPredicates()
           
 UUID getStartResult()
           
 Long getStartTime()
           
 List<Identifier> getUsers()
           
 List<UUID> getUuidIdentifiers()
           
 boolean hasQueryPredicates()
          Return true if this query has parameters
 boolean hasSelectSubjects()
           
 boolean hasSortPredicates()
           
 boolean isIdsOnly()
           
 boolean isLimitSet()
           
 boolean isMergeSelectResults()
           
 boolean isPad()
           
 boolean isReversed()
           
 boolean isReversedSet()
           
static Query newQueryIfNull(Query query)
           
static Query searchForProperty(String propertyName, Object propertyValue)
           
 void setCategories(List<String> categories)
           
 void setConnectionType(String connection)
           
 void setCounterFilters(List<Query.CounterFilterPredicate> counterFilters)
           
 void setCursor(String cursor)
           
 void setEntityType(String type)
           
 void setFinishTime(Long finishTime)
           
 void setGroups(List<Identifier> groups)
           
 void setIdentifiers(List<Identifier> identifiers)
           
 void setIdsOnly(boolean idsOnly)
           
 void setLimit(int limit)
           
 void setMergeSelectResults(boolean mergeSelectResults)
           
 void setPad(boolean pad)
           
 void setPermissions(List<String> permissions)
           
 void setResolution(CounterResolution resolution)
           
 void setResultsLevel(Results.Level level)
           
 void setReversed(boolean reversed)
           
 void setRootOperand(Operand root)
           
 void setStartResult(UUID startResult)
           
 void setStartTime(Long startTime)
           
 void setUsers(List<Identifier> users)
           
 String toString()
           
 Query withConnectionType(String connection)
           
 Query withCursor(String cursor)
           
 Query withEntityType(String type)
           
 Query withLimit(int limit)
           
 Query withMergeSelectResults(boolean mergeSelectResults)
           
 Query withPermissions(List<String> permissions)
           
 Query withResultsLevel(Results.Level level)
           
 Query withStartResult(UUID startResult)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT
See Also:
Constant Field Values

type

protected String type

sortPredicates

protected List<Query.SortPredicate> sortPredicates

rootOperand

protected Operand rootOperand

startResult

protected UUID startResult

cursor

protected String cursor

limit

protected int limit

limitSet

protected boolean limitSet

selectSubjects

protected Map<String,String> selectSubjects

mergeSelectResults

protected boolean mergeSelectResults

level

protected Results.Level level

connection

protected String connection

permissions

protected List<String> permissions

reversed

protected boolean reversed

reversedSet

protected boolean reversedSet

startTime

protected Long startTime

finishTime

protected Long finishTime

pad

protected boolean pad

resolution

protected CounterResolution resolution

users

protected List<Identifier> users

groups

protected List<Identifier> groups

identifiers

protected List<Identifier> identifiers

categories

protected List<String> categories

counterFilters

protected List<Query.CounterFilterPredicate> counterFilters
Constructor Detail

Query

public Query()

Query

public Query(Query q)
Method Detail

fromQL

public static Query fromQL(String ql)
                    throws QueryParseException
Throws:
QueryParseException

newQueryIfNull

public static Query newQueryIfNull(Query query)

fromJsonString

public static Query fromJsonString(String json)
                            throws QueryParseException
Throws:
QueryParseException

fromQueryParams

public static Query fromQueryParams(Map<String,List<String>> params)
                             throws QueryParseException
Throws:
QueryParseException

searchForProperty

public static Query searchForProperty(String propertyName,
                                      Object propertyValue)

findForProperty

public static Query findForProperty(String propertyName,
                                    Object propertyValue)

fromUUID

public static Query fromUUID(UUID uuid)

fromName

public static Query fromName(String name)

fromEmail

public static Query fromEmail(String email)

fromIdentifier

public static Query fromIdentifier(Object id)

hasQueryPredicates

public boolean hasQueryPredicates()
Return true if this query has parameters

Returns:

containsNameOrEmailIdentifiersOnly

public boolean containsNameOrEmailIdentifiersOnly()

getSingleNameOrEmailIdentifier

public String getSingleNameOrEmailIdentifier()

containsSingleNameOrEmailIdentifier

public boolean containsSingleNameOrEmailIdentifier()

containsSingleUuidIdentifier

public boolean containsSingleUuidIdentifier()

containsUuidIdentifersOnly

public boolean containsUuidIdentifersOnly()

getSingleUuidIdentifier

public UUID getSingleUuidIdentifier()

isIdsOnly

public boolean isIdsOnly()

setIdsOnly

public void setIdsOnly(boolean idsOnly)

getResultsLevel

public Results.Level getResultsLevel()

setResultsLevel

public void setResultsLevel(Results.Level level)

withResultsLevel

public Query withResultsLevel(Results.Level level)

getEntityType

public String getEntityType()

setEntityType

public void setEntityType(String type)

withEntityType

public Query withEntityType(String type)

getConnectionType

public String getConnectionType()

setConnectionType

public void setConnectionType(String connection)

withConnectionType

public Query withConnectionType(String connection)

getPermissions

public List<String> getPermissions()

setPermissions

public void setPermissions(List<String> permissions)

withPermissions

public Query withPermissions(List<String> permissions)

addSelect

public Query addSelect(String select)

addSelect

public Query addSelect(String select,
                       String output)

hasSelectSubjects

public boolean hasSelectSubjects()

getSelectSubjects

public Set<String> getSelectSubjects()

getSelectAssignments

public Map<String,String> getSelectAssignments()

setMergeSelectResults

public void setMergeSelectResults(boolean mergeSelectResults)

withMergeSelectResults

public Query withMergeSelectResults(boolean mergeSelectResults)

isMergeSelectResults

public boolean isMergeSelectResults()

addSort

public Query addSort(String propertyName)

addSort

public Query addSort(String propertyName,
                     Query.SortDirection direction)

addSort

public Query addSort(Query.SortPredicate sort)

getSortPredicates

public List<Query.SortPredicate> getSortPredicates()

hasSortPredicates

public boolean hasSortPredicates()

addFilter

public Query addFilter(String filter)
Add the filter from a string

Parameters:
filter -
Returns:
Throws:
org.antlr.runtime.RecognitionException

addLessThanFilter

public Query addLessThanFilter(String propName,
                               Object value)
Add a less than filter to this query. && with existing clauses

Parameters:
propName -
value -
Returns:

addLessThanEqualFilter

public Query addLessThanEqualFilter(String propName,
                                    Object value)
Add a less than equal filter to this query. && with existing clauses

Parameters:
propName -
value -
Returns:

addEqualityFilter

public Query addEqualityFilter(String propName,
                               Object value)
Add a equal filter to this query. && with existing clauses

Parameters:
propName -
value -
Returns:

addGreaterThanEqualFilter

public Query addGreaterThanEqualFilter(String propName,
                                       Object value)
Add a greater than equal filter to this query. && with existing clauses

Parameters:
propName -
value -
Returns:

addGreaterThanFilter

public Query addGreaterThanFilter(String propName,
                                  Object value)
Add a less than filter to this query. && with existing clauses

Parameters:
propName -
value -
Returns:

addContainsFilter

public Query addContainsFilter(String propName,
                               String keyword)
Parameters:
propName -
keyword -
Returns:

addLocationFilter

public Query addLocationFilter(String propName,
                               float distance,
                               float lattitude,
                               float longitude)
Parameters:
propName -
distance -
lattitude -
longitude -
Returns:

getRootOperand

public Operand getRootOperand()

setRootOperand

public void setRootOperand(Operand root)

setStartResult

public void setStartResult(UUID startResult)

withStartResult

public Query withStartResult(UUID startResult)

getStartResult

public UUID getStartResult()

getCursor

public String getCursor()

setCursor

public void setCursor(String cursor)

withCursor

public Query withCursor(String cursor)

getLimit

public int getLimit()

getLimit

public int getLimit(int defaultLimit)

setLimit

public void setLimit(int limit)

withLimit

public Query withLimit(int limit)

isLimitSet

public boolean isLimitSet()

isReversed

public boolean isReversed()

setReversed

public void setReversed(boolean reversed)

isReversedSet

public boolean isReversedSet()

getStartTime

public Long getStartTime()

setStartTime

public void setStartTime(Long startTime)

getFinishTime

public Long getFinishTime()

setFinishTime

public void setFinishTime(Long finishTime)

isPad

public boolean isPad()

setPad

public void setPad(boolean pad)

setResolution

public void setResolution(CounterResolution resolution)

getResolution

public CounterResolution getResolution()

getUsers

public List<Identifier> getUsers()

addUser

public void addUser(Identifier user)

setUsers

public void setUsers(List<Identifier> users)

getGroups

public List<Identifier> getGroups()

addGroup

public void addGroup(Identifier group)

setGroups

public void setGroups(List<Identifier> groups)

getIdentifiers

public List<Identifier> getIdentifiers()

addIdentifier

public void addIdentifier(Identifier identifier)

setIdentifiers

public void setIdentifiers(List<Identifier> identifiers)

getUuidIdentifiers

public List<UUID> getUuidIdentifiers()

getNameIdentifiers

public List<String> getNameIdentifiers()

getEmailIdentifiers

public List<String> getEmailIdentifiers()

getNameAndEmailIdentifiers

public List<String> getNameAndEmailIdentifiers()

getCategories

public List<String> getCategories()

addCategory

public void addCategory(String category)

setCategories

public void setCategories(List<String> categories)

getCounterFilters

public List<Query.CounterFilterPredicate> getCounterFilters()

addCounterFilter

public void addCounterFilter(String counter)

setCounterFilters

public void setCounterFilters(List<Query.CounterFilterPredicate> counterFilters)

toString

public String toString()
Overrides:
toString in class Object

getSelectionResults

public List<Object> getSelectionResults(Results rs)

getSelectionResult

public Object getSelectionResult(Results rs)


Copyright © 2013. All Rights Reserved.