org.apache.blur.thrift.generated
Class Selector

java.lang.Object
  extended by org.apache.blur.thrift.generated.Selector
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Selector>, TBase<Selector,Selector._Fields>

public class Selector
extends Object
implements TBase<Selector,Selector._Fields>, Serializable, Cloneable

Select carries the request for information to be retrieved from the stored columns.

See Also:
Serialized Form

Nested Class Summary
static class Selector._Fields
          The set of fields this struct contains, along with convenience methods for finding and manipulating them.
 
Field Summary
 Set<String> columnFamiliesToFetch
          The column families to fetch.
 Map<String,Set<String>> columnsToFetch
          The columns in the families to fetch.
 HighlightOptions highlightOptions
          The HighlightOptions object controls how the data is highlighted.
 String locationId
          WARNING: This is an internal only attribute and is not intended for use by clients.
 int maxRecordsToFetch
          Only valid for Row fetches, the number of records to fetch.
static Map<Selector._Fields,FieldMetaData> metaDataMap
           
 List<String> orderOfFamiliesToFetch
          Can be null, if provided the provided family order will be the order in which the families are returned.
 String recordId
          The record id of the Record to be fetched, not to be used with location id.
 boolean recordOnly
          Fetch the Record only, not the entire Row.
 String rowId
          The row id of the Row to be fetched, not to be used with location id.
 int startRecord
          Only valid for Row fetches, the record in the row to start fetching.
 
Constructor Summary
Selector()
           
Selector(boolean recordOnly, String locationId, String rowId, String recordId, Set<String> columnFamiliesToFetch, Map<String,Set<String>> columnsToFetch, int startRecord, int maxRecordsToFetch, HighlightOptions highlightOptions, List<String> orderOfFamiliesToFetch)
           
Selector(Selector other)
          Performs a deep copy on other.
 
Method Summary
 void addToColumnFamiliesToFetch(String elem)
           
 void addToOrderOfFamiliesToFetch(String elem)
           
 void clear()
          Return to the state of having just been initialized, as though you had just called the default constructor.
 int compareTo(Selector other)
           
 Selector deepCopy()
           
 boolean equals(Object that)
           
 boolean equals(Selector that)
           
 Selector._Fields fieldForId(int fieldId)
          Get the F instance that corresponds to fieldId.
 Set<String> getColumnFamiliesToFetch()
          The column families to fetch.
 Iterator<String> getColumnFamiliesToFetchIterator()
           
 int getColumnFamiliesToFetchSize()
           
 Map<String,Set<String>> getColumnsToFetch()
          The columns in the families to fetch.
 int getColumnsToFetchSize()
           
 Object getFieldValue(Selector._Fields field)
          Get a field's value by field variable.
 HighlightOptions getHighlightOptions()
          The HighlightOptions object controls how the data is highlighted.
 String getLocationId()
          WARNING: This is an internal only attribute and is not intended for use by clients.
 int getMaxRecordsToFetch()
          Only valid for Row fetches, the number of records to fetch.
 List<String> getOrderOfFamiliesToFetch()
          Can be null, if provided the provided family order will be the order in which the families are returned.
 Iterator<String> getOrderOfFamiliesToFetchIterator()
           
 int getOrderOfFamiliesToFetchSize()
           
 String getRecordId()
          The record id of the Record to be fetched, not to be used with location id.
 String getRowId()
          The row id of the Row to be fetched, not to be used with location id.
 int getStartRecord()
          Only valid for Row fetches, the record in the row to start fetching.
 int hashCode()
           
 boolean isRecordOnly()
          Fetch the Record only, not the entire Row.
 boolean isSet(Selector._Fields field)
          Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
 boolean isSetColumnFamiliesToFetch()
          Returns true if field columnFamiliesToFetch is set (has been assigned a value) and false otherwise
 boolean isSetColumnsToFetch()
          Returns true if field columnsToFetch is set (has been assigned a value) and false otherwise
 boolean isSetHighlightOptions()
          Returns true if field highlightOptions is set (has been assigned a value) and false otherwise
 boolean isSetLocationId()
          Returns true if field locationId is set (has been assigned a value) and false otherwise
 boolean isSetMaxRecordsToFetch()
          Returns true if field maxRecordsToFetch is set (has been assigned a value) and false otherwise
 boolean isSetOrderOfFamiliesToFetch()
          Returns true if field orderOfFamiliesToFetch is set (has been assigned a value) and false otherwise
 boolean isSetRecordId()
          Returns true if field recordId is set (has been assigned a value) and false otherwise
 boolean isSetRecordOnly()
          Returns true if field recordOnly is set (has been assigned a value) and false otherwise
 boolean isSetRowId()
          Returns true if field rowId is set (has been assigned a value) and false otherwise
 boolean isSetStartRecord()
          Returns true if field startRecord is set (has been assigned a value) and false otherwise
 void putToColumnsToFetch(String key, Set<String> val)
           
 void read(TProtocol iprot)
          Reads the TObject from the given input protocol.
 Selector setColumnFamiliesToFetch(Set<String> columnFamiliesToFetch)
          The column families to fetch.
 void setColumnFamiliesToFetchIsSet(boolean value)
           
 Selector setColumnsToFetch(Map<String,Set<String>> columnsToFetch)
          The columns in the families to fetch.
 void setColumnsToFetchIsSet(boolean value)
           
 void setFieldValue(Selector._Fields field, Object value)
          Set a field's value by field variable.
 Selector setHighlightOptions(HighlightOptions highlightOptions)
          The HighlightOptions object controls how the data is highlighted.
 void setHighlightOptionsIsSet(boolean value)
           
 Selector setLocationId(String locationId)
          WARNING: This is an internal only attribute and is not intended for use by clients.
 void setLocationIdIsSet(boolean value)
           
 Selector setMaxRecordsToFetch(int maxRecordsToFetch)
          Only valid for Row fetches, the number of records to fetch.
 void setMaxRecordsToFetchIsSet(boolean value)
           
 Selector setOrderOfFamiliesToFetch(List<String> orderOfFamiliesToFetch)
          Can be null, if provided the provided family order will be the order in which the families are returned.
 void setOrderOfFamiliesToFetchIsSet(boolean value)
           
 Selector setRecordId(String recordId)
          The record id of the Record to be fetched, not to be used with location id.
 void setRecordIdIsSet(boolean value)
           
 Selector setRecordOnly(boolean recordOnly)
          Fetch the Record only, not the entire Row.
 void setRecordOnlyIsSet(boolean value)
           
 Selector setRowId(String rowId)
          The row id of the Row to be fetched, not to be used with location id.
 void setRowIdIsSet(boolean value)
           
 Selector setStartRecord(int startRecord)
          Only valid for Row fetches, the record in the row to start fetching.
 void setStartRecordIsSet(boolean value)
           
 String toString()
           
 void unsetColumnFamiliesToFetch()
           
 void unsetColumnsToFetch()
           
 void unsetHighlightOptions()
           
 void unsetLocationId()
           
 void unsetMaxRecordsToFetch()
           
 void unsetOrderOfFamiliesToFetch()
           
 void unsetRecordId()
           
 void unsetRecordOnly()
           
 void unsetRowId()
           
 void unsetStartRecord()
           
 void validate()
           
 void write(TProtocol oprot)
          Writes the objects out to the protocol
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

recordOnly

public boolean recordOnly
Fetch the Record only, not the entire Row.


locationId

public String locationId
WARNING: This is an internal only attribute and is not intended for use by clients. The location id of the Record or Row to be fetched.


rowId

public String rowId
The row id of the Row to be fetched, not to be used with location id.


recordId

public String recordId
The record id of the Record to be fetched, not to be used with location id. However the row id needs to be provided to locate the correct Row with the requested Record.


columnFamiliesToFetch

public Set<String> columnFamiliesToFetch
The column families to fetch. If null, fetch all. If empty, fetch none.


columnsToFetch

public Map<String,Set<String>> columnsToFetch
The columns in the families to fetch. If null, fetch all. If empty, fetch none.


startRecord

public int startRecord
Only valid for Row fetches, the record in the row to start fetching. If the row contains 1000 records and you want the first 100, then this value is 0. If you want records 300-400 then this value would be 300. If startRecord is beyond the end of the row, the row will be null in the FetchResult. Used in conjunction with maxRecordsToFetch.


maxRecordsToFetch

public int maxRecordsToFetch
Only valid for Row fetches, the number of records to fetch. If the row contains 1000 records and you want the first 100, then this value is 100. If you want records 300-400 then this value would be 100. Used in conjunction with startRecord. By default this will fetch the first 1000 records of the row.


highlightOptions

public HighlightOptions highlightOptions
The HighlightOptions object controls how the data is highlighted. If null no highlighting will occur.


orderOfFamiliesToFetch

public List<String> orderOfFamiliesToFetch
Can be null, if provided the provided family order will be the order in which the families are returned.


metaDataMap

public static final Map<Selector._Fields,FieldMetaData> metaDataMap
Constructor Detail

Selector

public Selector()

Selector

public Selector(boolean recordOnly,
                String locationId,
                String rowId,
                String recordId,
                Set<String> columnFamiliesToFetch,
                Map<String,Set<String>> columnsToFetch,
                int startRecord,
                int maxRecordsToFetch,
                HighlightOptions highlightOptions,
                List<String> orderOfFamiliesToFetch)

Selector

public Selector(Selector other)
Performs a deep copy on other.

Method Detail

deepCopy

public Selector deepCopy()
Specified by:
deepCopy in interface TBase<Selector,Selector._Fields>

clear

public void clear()
Description copied from interface: TBase
Return to the state of having just been initialized, as though you had just called the default constructor.

Specified by:
clear in interface TBase<Selector,Selector._Fields>

isRecordOnly

public boolean isRecordOnly()
Fetch the Record only, not the entire Row.


setRecordOnly

public Selector setRecordOnly(boolean recordOnly)
Fetch the Record only, not the entire Row.


unsetRecordOnly

public void unsetRecordOnly()

isSetRecordOnly

public boolean isSetRecordOnly()
Returns true if field recordOnly is set (has been assigned a value) and false otherwise


setRecordOnlyIsSet

public void setRecordOnlyIsSet(boolean value)

getLocationId

public String getLocationId()
WARNING: This is an internal only attribute and is not intended for use by clients. The location id of the Record or Row to be fetched.


setLocationId

public Selector setLocationId(String locationId)
WARNING: This is an internal only attribute and is not intended for use by clients. The location id of the Record or Row to be fetched.


unsetLocationId

public void unsetLocationId()

isSetLocationId

public boolean isSetLocationId()
Returns true if field locationId is set (has been assigned a value) and false otherwise


setLocationIdIsSet

public void setLocationIdIsSet(boolean value)

getRowId

public String getRowId()
The row id of the Row to be fetched, not to be used with location id.


setRowId

public Selector setRowId(String rowId)
The row id of the Row to be fetched, not to be used with location id.


unsetRowId

public void unsetRowId()

isSetRowId

public boolean isSetRowId()
Returns true if field rowId is set (has been assigned a value) and false otherwise


setRowIdIsSet

public void setRowIdIsSet(boolean value)

getRecordId

public String getRecordId()
The record id of the Record to be fetched, not to be used with location id. However the row id needs to be provided to locate the correct Row with the requested Record.


setRecordId

public Selector setRecordId(String recordId)
The record id of the Record to be fetched, not to be used with location id. However the row id needs to be provided to locate the correct Row with the requested Record.


unsetRecordId

public void unsetRecordId()

isSetRecordId

public boolean isSetRecordId()
Returns true if field recordId is set (has been assigned a value) and false otherwise


setRecordIdIsSet

public void setRecordIdIsSet(boolean value)

getColumnFamiliesToFetchSize

public int getColumnFamiliesToFetchSize()

getColumnFamiliesToFetchIterator

public Iterator<String> getColumnFamiliesToFetchIterator()

addToColumnFamiliesToFetch

public void addToColumnFamiliesToFetch(String elem)

getColumnFamiliesToFetch

public Set<String> getColumnFamiliesToFetch()
The column families to fetch. If null, fetch all. If empty, fetch none.


setColumnFamiliesToFetch

public Selector setColumnFamiliesToFetch(Set<String> columnFamiliesToFetch)
The column families to fetch. If null, fetch all. If empty, fetch none.


unsetColumnFamiliesToFetch

public void unsetColumnFamiliesToFetch()

isSetColumnFamiliesToFetch

public boolean isSetColumnFamiliesToFetch()
Returns true if field columnFamiliesToFetch is set (has been assigned a value) and false otherwise


setColumnFamiliesToFetchIsSet

public void setColumnFamiliesToFetchIsSet(boolean value)

getColumnsToFetchSize

public int getColumnsToFetchSize()

putToColumnsToFetch

public void putToColumnsToFetch(String key,
                                Set<String> val)

getColumnsToFetch

public Map<String,Set<String>> getColumnsToFetch()
The columns in the families to fetch. If null, fetch all. If empty, fetch none.


setColumnsToFetch

public Selector setColumnsToFetch(Map<String,Set<String>> columnsToFetch)
The columns in the families to fetch. If null, fetch all. If empty, fetch none.


unsetColumnsToFetch

public void unsetColumnsToFetch()

isSetColumnsToFetch

public boolean isSetColumnsToFetch()
Returns true if field columnsToFetch is set (has been assigned a value) and false otherwise


setColumnsToFetchIsSet

public void setColumnsToFetchIsSet(boolean value)

getStartRecord

public int getStartRecord()
Only valid for Row fetches, the record in the row to start fetching. If the row contains 1000 records and you want the first 100, then this value is 0. If you want records 300-400 then this value would be 300. If startRecord is beyond the end of the row, the row will be null in the FetchResult. Used in conjunction with maxRecordsToFetch.


setStartRecord

public Selector setStartRecord(int startRecord)
Only valid for Row fetches, the record in the row to start fetching. If the row contains 1000 records and you want the first 100, then this value is 0. If you want records 300-400 then this value would be 300. If startRecord is beyond the end of the row, the row will be null in the FetchResult. Used in conjunction with maxRecordsToFetch.


unsetStartRecord

public void unsetStartRecord()

isSetStartRecord

public boolean isSetStartRecord()
Returns true if field startRecord is set (has been assigned a value) and false otherwise


setStartRecordIsSet

public void setStartRecordIsSet(boolean value)

getMaxRecordsToFetch

public int getMaxRecordsToFetch()
Only valid for Row fetches, the number of records to fetch. If the row contains 1000 records and you want the first 100, then this value is 100. If you want records 300-400 then this value would be 100. Used in conjunction with startRecord. By default this will fetch the first 1000 records of the row.


setMaxRecordsToFetch

public Selector setMaxRecordsToFetch(int maxRecordsToFetch)
Only valid for Row fetches, the number of records to fetch. If the row contains 1000 records and you want the first 100, then this value is 100. If you want records 300-400 then this value would be 100. Used in conjunction with startRecord. By default this will fetch the first 1000 records of the row.


unsetMaxRecordsToFetch

public void unsetMaxRecordsToFetch()

isSetMaxRecordsToFetch

public boolean isSetMaxRecordsToFetch()
Returns true if field maxRecordsToFetch is set (has been assigned a value) and false otherwise


setMaxRecordsToFetchIsSet

public void setMaxRecordsToFetchIsSet(boolean value)

getHighlightOptions

public HighlightOptions getHighlightOptions()
The HighlightOptions object controls how the data is highlighted. If null no highlighting will occur.


setHighlightOptions

public Selector setHighlightOptions(HighlightOptions highlightOptions)
The HighlightOptions object controls how the data is highlighted. If null no highlighting will occur.


unsetHighlightOptions

public void unsetHighlightOptions()

isSetHighlightOptions

public boolean isSetHighlightOptions()
Returns true if field highlightOptions is set (has been assigned a value) and false otherwise


setHighlightOptionsIsSet

public void setHighlightOptionsIsSet(boolean value)

getOrderOfFamiliesToFetchSize

public int getOrderOfFamiliesToFetchSize()

getOrderOfFamiliesToFetchIterator

public Iterator<String> getOrderOfFamiliesToFetchIterator()

addToOrderOfFamiliesToFetch

public void addToOrderOfFamiliesToFetch(String elem)

getOrderOfFamiliesToFetch

public List<String> getOrderOfFamiliesToFetch()
Can be null, if provided the provided family order will be the order in which the families are returned.


setOrderOfFamiliesToFetch

public Selector setOrderOfFamiliesToFetch(List<String> orderOfFamiliesToFetch)
Can be null, if provided the provided family order will be the order in which the families are returned.


unsetOrderOfFamiliesToFetch

public void unsetOrderOfFamiliesToFetch()

isSetOrderOfFamiliesToFetch

public boolean isSetOrderOfFamiliesToFetch()
Returns true if field orderOfFamiliesToFetch is set (has been assigned a value) and false otherwise


setOrderOfFamiliesToFetchIsSet

public void setOrderOfFamiliesToFetchIsSet(boolean value)

setFieldValue

public void setFieldValue(Selector._Fields field,
                          Object value)
Description copied from interface: TBase
Set a field's value by field variable. Primitive types must be "boxed" in the appropriate object wrapper type.

Specified by:
setFieldValue in interface TBase<Selector,Selector._Fields>

getFieldValue

public Object getFieldValue(Selector._Fields field)
Description copied from interface: TBase
Get a field's value by field variable. Primitive types will be wrapped in the appropriate "boxed" types.

Specified by:
getFieldValue in interface TBase<Selector,Selector._Fields>

isSet

public boolean isSet(Selector._Fields field)
Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise

Specified by:
isSet in interface TBase<Selector,Selector._Fields>

equals

public boolean equals(Object that)
Overrides:
equals in class Object

equals

public boolean equals(Selector that)

hashCode

public int hashCode()
Overrides:
hashCode in class Object

compareTo

public int compareTo(Selector other)
Specified by:
compareTo in interface Comparable<Selector>

fieldForId

public Selector._Fields fieldForId(int fieldId)
Description copied from interface: TBase
Get the F instance that corresponds to fieldId.

Specified by:
fieldForId in interface TBase<Selector,Selector._Fields>

read

public void read(TProtocol iprot)
          throws TException
Description copied from interface: TBase
Reads the TObject from the given input protocol.

Specified by:
read in interface TBase<Selector,Selector._Fields>
Parameters:
iprot - Input protocol
Throws:
TException

write

public void write(TProtocol oprot)
           throws TException
Description copied from interface: TBase
Writes the objects out to the protocol

Specified by:
write in interface TBase<Selector,Selector._Fields>
Parameters:
oprot - Output protocol
Throws:
TException

toString

public String toString()
Overrides:
toString in class Object

validate

public void validate()
              throws TException
Throws:
TException


Copyright © 2012-2014 The Apache Software Foundation. All Rights Reserved.