|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.blur.thrift.generated.Selector
public class Selector
Select carries the request for information to be retrieved from the stored columns.
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 |
---|
public boolean recordOnly
public String locationId
public String rowId
public String recordId
public Set<String> columnFamiliesToFetch
public Map<String,Set<String>> columnsToFetch
public int startRecord
public int maxRecordsToFetch
public HighlightOptions highlightOptions
public List<String> orderOfFamiliesToFetch
public static final Map<Selector._Fields,FieldMetaData> metaDataMap
Constructor Detail |
---|
public 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)
public Selector(Selector other)
Method Detail |
---|
public Selector deepCopy()
deepCopy
in interface TBase<Selector,Selector._Fields>
public void clear()
TBase
clear
in interface TBase<Selector,Selector._Fields>
public boolean isRecordOnly()
public Selector setRecordOnly(boolean recordOnly)
public void unsetRecordOnly()
public boolean isSetRecordOnly()
public void setRecordOnlyIsSet(boolean value)
public String getLocationId()
public Selector setLocationId(String locationId)
public void unsetLocationId()
public boolean isSetLocationId()
public void setLocationIdIsSet(boolean value)
public String getRowId()
public Selector setRowId(String rowId)
public void unsetRowId()
public boolean isSetRowId()
public void setRowIdIsSet(boolean value)
public String getRecordId()
public Selector setRecordId(String recordId)
public void unsetRecordId()
public boolean isSetRecordId()
public void setRecordIdIsSet(boolean value)
public int getColumnFamiliesToFetchSize()
public Iterator<String> getColumnFamiliesToFetchIterator()
public void addToColumnFamiliesToFetch(String elem)
public Set<String> getColumnFamiliesToFetch()
public Selector setColumnFamiliesToFetch(Set<String> columnFamiliesToFetch)
public void unsetColumnFamiliesToFetch()
public boolean isSetColumnFamiliesToFetch()
public void setColumnFamiliesToFetchIsSet(boolean value)
public int getColumnsToFetchSize()
public void putToColumnsToFetch(String key, Set<String> val)
public Map<String,Set<String>> getColumnsToFetch()
public Selector setColumnsToFetch(Map<String,Set<String>> columnsToFetch)
public void unsetColumnsToFetch()
public boolean isSetColumnsToFetch()
public void setColumnsToFetchIsSet(boolean value)
public int getStartRecord()
public Selector setStartRecord(int startRecord)
public void unsetStartRecord()
public boolean isSetStartRecord()
public void setStartRecordIsSet(boolean value)
public int getMaxRecordsToFetch()
public Selector setMaxRecordsToFetch(int maxRecordsToFetch)
public void unsetMaxRecordsToFetch()
public boolean isSetMaxRecordsToFetch()
public void setMaxRecordsToFetchIsSet(boolean value)
public HighlightOptions getHighlightOptions()
public Selector setHighlightOptions(HighlightOptions highlightOptions)
public void unsetHighlightOptions()
public boolean isSetHighlightOptions()
public void setHighlightOptionsIsSet(boolean value)
public int getOrderOfFamiliesToFetchSize()
public Iterator<String> getOrderOfFamiliesToFetchIterator()
public void addToOrderOfFamiliesToFetch(String elem)
public List<String> getOrderOfFamiliesToFetch()
public Selector setOrderOfFamiliesToFetch(List<String> orderOfFamiliesToFetch)
public void unsetOrderOfFamiliesToFetch()
public boolean isSetOrderOfFamiliesToFetch()
public void setOrderOfFamiliesToFetchIsSet(boolean value)
public void setFieldValue(Selector._Fields field, Object value)
TBase
setFieldValue
in interface TBase<Selector,Selector._Fields>
public Object getFieldValue(Selector._Fields field)
TBase
getFieldValue
in interface TBase<Selector,Selector._Fields>
public boolean isSet(Selector._Fields field)
isSet
in interface TBase<Selector,Selector._Fields>
public boolean equals(Object that)
equals
in class Object
public boolean equals(Selector that)
public int hashCode()
hashCode
in class Object
public int compareTo(Selector other)
compareTo
in interface Comparable<Selector>
public Selector._Fields fieldForId(int fieldId)
TBase
fieldForId
in interface TBase<Selector,Selector._Fields>
public void read(TProtocol iprot) throws TException
TBase
read
in interface TBase<Selector,Selector._Fields>
iprot
- Input protocol
TException
public void write(TProtocol oprot) throws TException
TBase
write
in interface TBase<Selector,Selector._Fields>
oprot
- Output protocol
TException
public String toString()
toString
in class Object
public void validate() throws TException
TException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |