|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.blur.thrift.generated.ColumnDefinition
public class ColumnDefinition
The ColumnDefinition defines how a given Column should be interpreted (indexed/stored)
Nested Class Summary | |
---|---|
static class |
ColumnDefinition._Fields
The set of fields this struct contains, along with convenience methods for finding and manipulating them. |
Field Summary | |
---|---|
String |
columnName
Required. |
String |
family
Required. |
boolean |
fieldLessIndexed
If this column should be searchable without having to specify the name of the column in the query. |
String |
fieldType
The field type for the column. |
static Map<ColumnDefinition._Fields,FieldMetaData> |
metaDataMap
|
Map<String,String> |
properties
For any custom field types, you can pass in configuration properties. |
boolean |
sortable
This will attempt to enable sorting for this column, if the type does not support sorting then an exception will be thrown. |
String |
subColumnName
If this column definition is for a sub column then provide the sub column name. |
Constructor Summary | |
---|---|
ColumnDefinition()
|
|
ColumnDefinition(ColumnDefinition other)
Performs a deep copy on other. |
|
ColumnDefinition(String family,
String columnName,
String subColumnName,
boolean fieldLessIndexed,
String fieldType,
Map<String,String> properties,
boolean sortable)
|
Method Summary | |
---|---|
void |
clear()
Return to the state of having just been initialized, as though you had just called the default constructor. |
int |
compareTo(ColumnDefinition other)
|
ColumnDefinition |
deepCopy()
|
boolean |
equals(ColumnDefinition that)
|
boolean |
equals(Object that)
|
ColumnDefinition._Fields |
fieldForId(int fieldId)
Get the F instance that corresponds to fieldId. |
String |
getColumnName()
Required. |
String |
getFamily()
Required. |
String |
getFieldType()
The field type for the column. |
Object |
getFieldValue(ColumnDefinition._Fields field)
Get a field's value by field variable. |
Map<String,String> |
getProperties()
For any custom field types, you can pass in configuration properties. |
int |
getPropertiesSize()
|
String |
getSubColumnName()
If this column definition is for a sub column then provide the sub column name. |
int |
hashCode()
|
boolean |
isFieldLessIndexed()
If this column should be searchable without having to specify the name of the column in the query. |
boolean |
isSet(ColumnDefinition._Fields field)
Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise |
boolean |
isSetColumnName()
Returns true if field columnName is set (has been assigned a value) and false otherwise |
boolean |
isSetFamily()
Returns true if field family is set (has been assigned a value) and false otherwise |
boolean |
isSetFieldLessIndexed()
Returns true if field fieldLessIndexed is set (has been assigned a value) and false otherwise |
boolean |
isSetFieldType()
Returns true if field fieldType is set (has been assigned a value) and false otherwise |
boolean |
isSetProperties()
Returns true if field properties is set (has been assigned a value) and false otherwise |
boolean |
isSetSortable()
Returns true if field sortable is set (has been assigned a value) and false otherwise |
boolean |
isSetSubColumnName()
Returns true if field subColumnName is set (has been assigned a value) and false otherwise |
boolean |
isSortable()
This will attempt to enable sorting for this column, if the type does not support sorting then an exception will be thrown. |
void |
putToProperties(String key,
String val)
|
void |
read(TProtocol iprot)
Reads the TObject from the given input protocol. |
ColumnDefinition |
setColumnName(String columnName)
Required. |
void |
setColumnNameIsSet(boolean value)
|
ColumnDefinition |
setFamily(String family)
Required. |
void |
setFamilyIsSet(boolean value)
|
ColumnDefinition |
setFieldLessIndexed(boolean fieldLessIndexed)
If this column should be searchable without having to specify the name of the column in the query. |
void |
setFieldLessIndexedIsSet(boolean value)
|
ColumnDefinition |
setFieldType(String fieldType)
The field type for the column. |
void |
setFieldTypeIsSet(boolean value)
|
void |
setFieldValue(ColumnDefinition._Fields field,
Object value)
Set a field's value by field variable. |
ColumnDefinition |
setProperties(Map<String,String> properties)
For any custom field types, you can pass in configuration properties. |
void |
setPropertiesIsSet(boolean value)
|
ColumnDefinition |
setSortable(boolean sortable)
This will attempt to enable sorting for this column, if the type does not support sorting then an exception will be thrown. |
void |
setSortableIsSet(boolean value)
|
ColumnDefinition |
setSubColumnName(String subColumnName)
If this column definition is for a sub column then provide the sub column name. |
void |
setSubColumnNameIsSet(boolean value)
|
String |
toString()
|
void |
unsetColumnName()
|
void |
unsetFamily()
|
void |
unsetFieldLessIndexed()
|
void |
unsetFieldType()
|
void |
unsetProperties()
|
void |
unsetSortable()
|
void |
unsetSubColumnName()
|
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 String family
public String columnName
public String subColumnName
public boolean fieldLessIndexed
public String fieldType
public Map<String,String> properties
public boolean sortable
public static final Map<ColumnDefinition._Fields,FieldMetaData> metaDataMap
Constructor Detail |
---|
public ColumnDefinition()
public ColumnDefinition(String family, String columnName, String subColumnName, boolean fieldLessIndexed, String fieldType, Map<String,String> properties, boolean sortable)
public ColumnDefinition(ColumnDefinition other)
Method Detail |
---|
public ColumnDefinition deepCopy()
deepCopy
in interface TBase<ColumnDefinition,ColumnDefinition._Fields>
public void clear()
TBase
clear
in interface TBase<ColumnDefinition,ColumnDefinition._Fields>
public String getFamily()
public ColumnDefinition setFamily(String family)
public void unsetFamily()
public boolean isSetFamily()
public void setFamilyIsSet(boolean value)
public String getColumnName()
public ColumnDefinition setColumnName(String columnName)
public void unsetColumnName()
public boolean isSetColumnName()
public void setColumnNameIsSet(boolean value)
public String getSubColumnName()
public ColumnDefinition setSubColumnName(String subColumnName)
public void unsetSubColumnName()
public boolean isSetSubColumnName()
public void setSubColumnNameIsSet(boolean value)
public boolean isFieldLessIndexed()
public ColumnDefinition setFieldLessIndexed(boolean fieldLessIndexed)
public void unsetFieldLessIndexed()
public boolean isSetFieldLessIndexed()
public void setFieldLessIndexedIsSet(boolean value)
public String getFieldType()
public ColumnDefinition setFieldType(String fieldType)
public void unsetFieldType()
public boolean isSetFieldType()
public void setFieldTypeIsSet(boolean value)
public int getPropertiesSize()
public void putToProperties(String key, String val)
public Map<String,String> getProperties()
public ColumnDefinition setProperties(Map<String,String> properties)
public void unsetProperties()
public boolean isSetProperties()
public void setPropertiesIsSet(boolean value)
public boolean isSortable()
public ColumnDefinition setSortable(boolean sortable)
public void unsetSortable()
public boolean isSetSortable()
public void setSortableIsSet(boolean value)
public void setFieldValue(ColumnDefinition._Fields field, Object value)
TBase
setFieldValue
in interface TBase<ColumnDefinition,ColumnDefinition._Fields>
public Object getFieldValue(ColumnDefinition._Fields field)
TBase
getFieldValue
in interface TBase<ColumnDefinition,ColumnDefinition._Fields>
public boolean isSet(ColumnDefinition._Fields field)
isSet
in interface TBase<ColumnDefinition,ColumnDefinition._Fields>
public boolean equals(Object that)
equals
in class Object
public boolean equals(ColumnDefinition that)
public int hashCode()
hashCode
in class Object
public int compareTo(ColumnDefinition other)
compareTo
in interface Comparable<ColumnDefinition>
public ColumnDefinition._Fields fieldForId(int fieldId)
TBase
fieldForId
in interface TBase<ColumnDefinition,ColumnDefinition._Fields>
public void read(TProtocol iprot) throws TException
TBase
read
in interface TBase<ColumnDefinition,ColumnDefinition._Fields>
iprot
- Input protocol
TException
public void write(TProtocol oprot) throws TException
TBase
write
in interface TBase<ColumnDefinition,ColumnDefinition._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 |