net.sourceforge.jbizmo.commons.search.dto

Class SearchInputField

java.lang.Object

net.sourceforge.jbizmo.commons.search.dto.SearchInputField

All Implemented Interfaces:

Serializable

public class SearchInputField
extends Object
implements Serializable

Data transfer object that contains filter and sorting information in order to generate parts of a query upon field level

Copyright 2016 (C) by Martin Ganserer

Version:

1.0.0

Author:

Martin Ganserer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchInputField() Default constructor
SearchInputField(String name, FilterOperatorEnum operator) Constructor
SearchInputField(String name, FilterOperatorEnum operator, String filterCriteria) Constructor
SearchInputField(String name, FilterOperatorEnum operator, String filterCriteria, SortDirectionEnum sortOrder) Constructor

Method Summary

Modifier and Type	Method and Description
String	getFilterCriteria()
String	getName()
FilterOperatorEnum	getOperator()
int	getSortIndex()
SortDirectionEnum	getSortOrder()
boolean	isDateTimeFormat()
void	setDateTimeFormat(boolean dateTimeFormat)
void	setFilterCriteria(String filterCriteria)
void	setName(String name) Set field name
void	setOperator(FilterOperatorEnum operator)
void	setSortIndex(int sortIndex)
void	setSortOrder(SortDirectionEnum sortOrder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchInputField

public SearchInputField()

Default constructor

SearchInputField

public SearchInputField(String name,
                        FilterOperatorEnum operator)

Constructor

Parameters:

name -

operator -

SearchInputField

public SearchInputField(String name,
                        FilterOperatorEnum operator,
                        String filterCriteria)

Constructor

Parameters:

name -

operator -

filterCriteria -

SearchInputField

public SearchInputField(String name,
                        FilterOperatorEnum operator,
                        String filterCriteria,
                        SortDirectionEnum sortOrder)

Constructor

Parameters:

name -

operator -

filterCriteria -

sortOrder -

Method Detail

getName

public String getName()

Returns:

the field's name

setName

public void setName(String name)

Set field name

Parameters:

name -

getOperator

public FilterOperatorEnum getOperator()

Returns:

the operator

setOperator

public void setOperator(FilterOperatorEnum operator)

Parameters:

operator -

getFilterCriteria

public String getFilterCriteria()

Returns:

the filter criteria

setFilterCriteria

public void setFilterCriteria(String filterCriteria)

Parameters:

filterCriteria -

getSortOrder

public SortDirectionEnum getSortOrder()

Returns:

the sort order

setSortOrder

public void setSortOrder(SortDirectionEnum sortOrder)

Parameters:

sortOrder -

getSortIndex

public int getSortIndex()

Returns:

the sort index

setSortIndex

public void setSortIndex(int sortIndex)

Parameters:

sortIndex -

isDateTimeFormat

public boolean isDateTimeFormat()

Returns:

a flag that determines if a date field is of type date time or date. Fields supplied with a different type should ignore the flag!

setDateTimeFormat

public void setDateTimeFormat(boolean dateTimeFormat)

Parameters:

dateTimeFormat -