public class SearchFieldDTO extends Object implements Serializable, Comparable<SearchFieldDTO>
Data transfer object that represents all information for generic search on field level There are three special properties that must be mentioned: 1) fetchIndex: This index is used to ease reading resultset data. 2) columnIndex: If a field is visible the value is greater or equal 0. This index is equivalent to the table column index. 3) colOrder: This value represents the column order. Note that this class has a natural ordering (see method compareTo()) that is inconsistent with equals().
Copyright 2010 (C) by Martin Ganserer
| Constructor and Description |
|---|
SearchFieldDTO()
Default constructor
|
SearchFieldDTO(int colDisplayOrder,
String colName,
String colLabel,
SearchFieldDataTypeEnum dataType,
int width)
Constructor
|
SearchFieldDTO(SearchFieldTypeEnum type,
int colDisplayOrder,
String colName,
String colLabel,
SearchFieldDataTypeEnum dataType,
int width)
Constructor
|
SearchFieldDTO(SearchFieldTypeEnum type,
int colDisplayOrder,
String colName,
String colLabel,
SearchFieldDataTypeEnum dataType,
int width,
String lov)
Constructor
|
| Modifier and Type | Method and Description |
|---|---|
int |
compareTo(SearchFieldDTO o) |
String |
getColLabel() |
String |
getColName() |
int |
getColOrder() |
int |
getColumnIndex() |
int |
getColWidth() |
SearchFieldDataTypeEnum |
getDataType() |
HashMap<String,String> |
getEnumListValues() |
int |
getFetchIndex() |
String |
getFilterCriteria() |
String |
getListOfValues() |
String |
getLovCommand() |
SearchOperatorDTO |
getOperator() |
int |
getOriginalColumnIndex() |
int |
getSortIndex() |
SortDirectionEnum |
getSortOrder() |
SearchFieldTypeEnum |
getType() |
boolean |
isDateTimeFormat() |
boolean |
isVisible() |
void |
setColLabel(String colLabel)
Set column label
|
void |
setColName(String colName)
Set column name
|
void |
setColOrder(int colDisplayOrder)
Set column order
|
void |
setColumnIndex(int columnIndex) |
void |
setColWidth(int colWidth)
Set column width
|
void |
setDataType(SearchFieldDataTypeEnum type)
Set column dataType
|
void |
setDateTimeFormat(boolean dateTimeFormat) |
void |
setEnumListValues(HashMap<String,String> enumListValues) |
void |
setFetchIndex(int colIndex)
Set column fetch index
|
void |
setFilterCriteria(String filterCriteria)
Sets the first search value
|
void |
setListOfValues(String listOfValues)
Set fully qualified class name of connected list of values
|
void |
setLovCommand(String lovCommand) |
void |
setOperator(SearchOperatorDTO operator)
Set operator
|
void |
setOriginalColumnIndex(int originalColumnIndex) |
void |
setSortIndex(int sortIndex) |
void |
setSortOrder(SortDirectionEnum sortOrder)
Set sort order
|
void |
setType(SearchFieldTypeEnum type)
Set search field type
|
void |
setVisible(boolean visible)
Set column visible
|
public SearchFieldDTO()
public SearchFieldDTO(int colDisplayOrder,
String colName,
String colLabel,
SearchFieldDataTypeEnum dataType,
int width)
colDisplayOrder - the display order of the columncolName - the name of property which is used in the select clause of the querycolLabel - the displayed name of the columndataType - the column dataTypewidth - the width of the columnpublic SearchFieldDTO(SearchFieldTypeEnum type, int colDisplayOrder, String colName, String colLabel, SearchFieldDataTypeEnum dataType, int width)
type - the field typecolDisplayOrder - the display order of the columncolName - the name of property which is used in the select clause of the querycolLabel - the displayed name of the columndataType - the column dataTypewidth - the width of the columnpublic SearchFieldDTO(SearchFieldTypeEnum type, int colDisplayOrder, String colName, String colLabel, SearchFieldDataTypeEnum dataType, int width, String lov)
type - the field typecolDisplayOrder - the display order of the columncolName - the name of property which is used in the select clause of the querycolLabel - the displayed name of the columndataType - the column dataTypewidth - the width of the columnlov - the fully qualified class name of the list of valuespublic String getListOfValues()
public void setListOfValues(String listOfValues)
listOfValues - public int compareTo(SearchFieldDTO o)
compareTo in interface Comparable<SearchFieldDTO>public int getColOrder()
public void setColOrder(int colDisplayOrder)
colDisplayOrder - public int getColWidth()
public void setColWidth(int colWidth)
colWidth - public String getColLabel()
public void setColLabel(String colLabel)
colLabel - public String getColName()
public void setColName(String colName)
colName - public SearchFieldDataTypeEnum getDataType()
public void setDataType(SearchFieldDataTypeEnum type)
type - public boolean isVisible()
public void setVisible(boolean visible)
visible - public int getFetchIndex()
public void setFetchIndex(int colIndex)
colIndex - public SearchOperatorDTO getOperator()
public void setOperator(SearchOperatorDTO operator)
operator - public String getFilterCriteria()
public void setFilterCriteria(String filterCriteria)
filterCriteria - public SortDirectionEnum getSortOrder()
public void setSortOrder(SortDirectionEnum sortOrder)
sortOrder - public SearchFieldTypeEnum getType()
public void setType(SearchFieldTypeEnum type)
type - public int getColumnIndex()
public void setColumnIndex(int columnIndex)
columnIndex - set column index to setpublic int getSortIndex()
public void setSortIndex(int sortIndex)
sortIndex - public int getOriginalColumnIndex()
public void setOriginalColumnIndex(int originalColumnIndex)
originalColumnIndex - public HashMap<String,String> getEnumListValues()
public void setEnumListValues(HashMap<String,String> enumListValues)
enumListValues - the hash map of enumeration values to setpublic String getLovCommand()
public void setLovCommand(String lovCommand)
lovCommand - the list of values command string to setpublic boolean isDateTimeFormat()
public void setDateTimeFormat(boolean dateTimeFormat)
dateTimeFormat - the dateTimeFormat to setCopyright © 2016. All rights reserved.