org.apache.gora.query.impl

Class QueryBase<K,T extends PersistentBase>

java.lang.Object

org.apache.gora.query.impl.QueryBase<K,T>

All Implemented Interfaces:

Query<K,T>, org.apache.hadoop.conf.Configurable, org.apache.hadoop.io.Writable

Direct Known Subclasses:

AccumuloQuery, AvroQuery, CassandraQuery, HBaseQuery, MemStore.MemQuery, PartitionQueryImpl, SolrQuery

public abstract class QueryBase<K,T extends PersistentBase>
extends Object
implements Query<K,T>, org.apache.hadoop.io.Writable, org.apache.hadoop.conf.Configurable

Base class for Query implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected DataStoreBase<K,T>	dataStore
protected K	endKey
protected long	endTime
protected String[]	fields
protected Filter<K,T>	filter
protected long	limit
protected boolean	localFilterEnabled
protected String	queryString
protected K	startKey
protected long	startTime

Constructor Summary

Constructors

Constructor and Description
QueryBase(DataStore<K,T> dataStore)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Result<K,T>	execute() Executes the Query on the DataStore and returns the results.
org.apache.hadoop.conf.Configuration	getConf()
DataStore<K,T>	getDataStore() Returns the DataStore, that this Query is associated with.
K	getEndKey()
long	getEndTime()
String[]	getFields()
Filter<K,T>	getFilter()
K	getKey()
long	getLimit() Returns the maximum number of results
K	getStartKey()
long	getStartTime()
long	getTimestamp()
int	hashCode()
boolean	isLocalFilterEnabled()
void	readFields(DataInput in)
void	setConf(org.apache.hadoop.conf.Configuration conf)
void	setDataStore(DataStore<K,T> dataStore) Sets the dataStore of this query.
void	setEndKey(K endKey)
void	setEndTime(long endTime)
void	setFields(String... fields)
void	setFilter(Filter<K,T> filter)
void	setKey(K key)
void	setKeyRange(K startKey, K endKey) Set the range of keys over which the query will execute.
void	setLimit(long limit) Sets the maximum number of results to return.
void	setLocalFilterEnabled(boolean enable) Set whether the local filter is enabled.
void	setStartKey(K startKey)
void	setStartTime(long startTime)
void	setTimeRange(long startTime, long endTime)
void	setTimestamp(long timestamp)
String	toString()
void	write(DataOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

dataStore

protected DataStoreBase<K,T extends PersistentBase> dataStore

queryString

protected String queryString

fields

protected String[] fields

startKey

protected K startKey

endKey

protected K endKey

startTime

protected long startTime

endTime

protected long endTime

filter

protected Filter<K,T extends PersistentBase> filter

localFilterEnabled

protected boolean localFilterEnabled

limit

protected long limit

Constructor Detail

QueryBase

public QueryBase(DataStore<K,T> dataStore)

Method Detail

execute

public Result<K,T> execute()

Description copied from interface: Query

Executes the Query on the DataStore and returns the results.

Specified by:

execute in interface Query<K,T extends PersistentBase>

Returns:

the Result for the query.

setDataStore

public void setDataStore(DataStore<K,T> dataStore)

Description copied from interface: Query

Sets the dataStore of this query. Under normal operation, this call is not necessary and it is potentially dangerous. So use this method only if you know what you are doing.

Specified by:

setDataStore in interface Query<K,T extends PersistentBase>

Parameters:

dataStore - the dataStore of the query

getDataStore

public DataStore<K,T> getDataStore()

Description copied from interface: Query

Returns the DataStore, that this Query is associated with.

Specified by:

getDataStore in interface Query<K,T extends PersistentBase>

Returns:

the DataStore of the Query

setFields

public void setFields(String... fields)

Specified by:

setFields in interface Query<K,T extends PersistentBase>

getFields

public String[] getFields()

Specified by:

getFields in interface Query<K,T extends PersistentBase>

getFilter

public Filter<K,T> getFilter()

Specified by:

getFilter in interface Query<K,T extends PersistentBase>

Returns:

The filter on this query, or null if none.

setFilter

public void setFilter(Filter<K,T> filter)

Specified by:

setFilter in interface Query<K,T extends PersistentBase>

isLocalFilterEnabled

public boolean isLocalFilterEnabled()

Specified by:

isLocalFilterEnabled in interface Query<K,T extends PersistentBase>

Returns:

Whether the local filter is enabled. See Query.setLocalFilterEnabled(boolean).

setLocalFilterEnabled

public void setLocalFilterEnabled(boolean enable)

Description copied from interface: Query

Set whether the local filter is enabled. This is usually called by data store implementations that install the filter remotely (for efficiency reasons) and therefore disable the local filter.

Specified by:

setLocalFilterEnabled in interface Query<K,T extends PersistentBase>

setKey

public void setKey(K key)

Specified by:

setKey in interface Query<K,T extends PersistentBase>

setStartKey

public void setStartKey(K startKey)

Specified by:

setStartKey in interface Query<K,T extends PersistentBase>

Parameters:

startKey - an inclusive start key

setEndKey

public void setEndKey(K endKey)

Specified by:

setEndKey in interface Query<K,T extends PersistentBase>

Parameters:

endKey - an inclusive end key

setKeyRange

public void setKeyRange(K startKey,
               K endKey)

Description copied from interface: Query

Set the range of keys over which the query will execute.

Specified by:

setKeyRange in interface Query<K,T extends PersistentBase>

Parameters:

startKey - an inclusive start key

endKey - an inclusive end key

getKey

public K getKey()

Specified by:

getKey in interface Query<K,T extends PersistentBase>

getStartKey

public K getStartKey()

Specified by:

getStartKey in interface Query<K,T extends PersistentBase>

getEndKey

public K getEndKey()

Specified by:

getEndKey in interface Query<K,T extends PersistentBase>

setTimestamp

public void setTimestamp(long timestamp)

Specified by:

setTimestamp in interface Query<K,T extends PersistentBase>

setStartTime

public void setStartTime(long startTime)

Specified by:

setStartTime in interface Query<K,T extends PersistentBase>

setEndTime

public void setEndTime(long endTime)

Specified by:

setEndTime in interface Query<K,T extends PersistentBase>

setTimeRange

public void setTimeRange(long startTime,
                long endTime)

Specified by:

setTimeRange in interface Query<K,T extends PersistentBase>

getTimestamp

public long getTimestamp()

Specified by:

getTimestamp in interface Query<K,T extends PersistentBase>

getStartTime

public long getStartTime()

Specified by:

getStartTime in interface Query<K,T extends PersistentBase>

getEndTime

public long getEndTime()

Specified by:

getEndTime in interface Query<K,T extends PersistentBase>

setLimit

public void setLimit(long limit)

Description copied from interface: Query

Sets the maximum number of results to return.

Specified by:

setLimit in interface Query<K,T extends PersistentBase>

getLimit

public long getLimit()

Description copied from interface: Query

Returns the maximum number of results

Specified by:

getLimit in interface Query<K,T extends PersistentBase>

Returns:

the limit if it is set, otherwise a negative number

getConf

public org.apache.hadoop.conf.Configuration getConf()

Specified by:

getConf in interface org.apache.hadoop.conf.Configurable

setConf

public void setConf(org.apache.hadoop.conf.Configuration conf)

Specified by:

setConf in interface org.apache.hadoop.conf.Configurable

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object