org.openlowcode.design.advanced

Class TimePeriodFilterElement

java.lang.Object

org.openlowcode.design.advanced.FilterElement<TimePeriod>

org.openlowcode.design.advanced.TimePeriodFilterElement

public class TimePeriodFilterElement
extends FilterElement<TimePeriod>

A filter element that will only show time periods corresponding to the selected values

Author:

Open Lowcode SAS

Field Summary

Fields inherited from class org.openlowcode.design.advanced.FilterElement

fatherisroot, linktoparent

Constructor Summary

Constructors

Constructor and Description
TimePeriodFilterElement(TimePeriodField timeperiodfield) create a time period filter where filter criteria will be input ( a time period selection widget will appear to allow selection of one time period)
TimePeriodFilterElement(TimePeriodField timeperiodfield, boolean needhelper) create a time period filter where filter criteria will be either input or automatically selected through an helper that the user should develop

Method Summary

Modifier and Type	Method and Description
ArgumentContent	getArgumentContent(java.lang.String suffix) should return an argument content with as base the name of object, the name of field, and the suffix
protected java.lang.String	getBlankValue()
java.lang.String[]	getImportClasses() provides the import classes to be put in the page
java.lang.String[]	getImportClassesForAction(java.lang.String reportname) provides he import classes to be put in the action
DataObjectDefinition	getParent()
protected boolean	hasfilterafter() A filter is considered as 'after' if it is a filter after the query was performed
protected boolean	hasfilterbefore() A filter is considered as 'before' if it is a condition to be put in the query to get children objects in the navigation
void	writeFilterCriteria(SourceGenerator sg, java.lang.String reportname) The filter criteria for the page of the smart report
void	writeFilterInDataGathering(SourceGenerator sg, java.lang.String prefixforlinkandchild, DataObjectDefinition reportroot, java.lang.String reportname) writes the filter code in the data gathering phase of the report

Methods inherited from class org.openlowcode.design.advanced.FilterElement

isHardCoded, setContext

Methods inherited from class java.lang.Object

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

Constructor Detail

TimePeriodFilterElement

public TimePeriodFilterElement(TimePeriodField timeperiodfield)

create a time period filter where filter criteria will be input ( a time period selection widget will appear to allow selection of one time period)

Parameters:

timeperiodfield - field to use for filter on the current node object

TimePeriodFilterElement

public TimePeriodFilterElement(TimePeriodField timeperiodfield,
                               boolean needhelper)

create a time period filter where filter criteria will be either input or automatically selected through an helper that the user should develop

Parameters:

timeperiodfield - field to use for filter on the current node object

needhelper - if true, the user will develop an helper to select the good time period, if false, a field will appear for user selection on the smart report page

Method Detail

getParent

public DataObjectDefinition getParent()

Specified by:

getParent in class FilterElement<TimePeriod>

Returns:

the parent of the filter (current data object node)

getArgumentContent

public ArgumentContent getArgumentContent(java.lang.String suffix)

Description copied from class: FilterElement

should return an argument content with as base the name of object, the name of field, and the suffix

Specified by:

getArgumentContent in class FilterElement<TimePeriod>

Parameters:

suffix - suffix of the current node in the report

Returns:

the argument content

writeFilterCriteria

public void writeFilterCriteria(SourceGenerator sg,
                                java.lang.String reportname)
                         throws java.io.IOException

Description copied from class: FilterElement

The filter criteria for the page of the smart report

Specified by:

writeFilterCriteria in class FilterElement<TimePeriod>

Parameters:

sg - source generator for the given file

reportname - name of the report

Throws:

java.io.IOException - if anything bad happens while writing the file

getImportClasses

public java.lang.String[] getImportClasses()

Description copied from class: FilterElement

provides the import classes to be put in the page

Specified by:

getImportClasses in class FilterElement<TimePeriod>

Returns:

an array of import statements

getImportClassesForAction

public java.lang.String[] getImportClassesForAction(java.lang.String reportname)

Description copied from class: FilterElement

provides he import classes to be put in the action

Specified by:

getImportClassesForAction in class FilterElement<TimePeriod>

Parameters:

reportname - name of the report

Returns:

an array of import statements

hasfilterbefore

protected boolean hasfilterbefore()

Description copied from class: FilterElement

A filter is considered as 'before' if it is a condition to be put in the query to get children objects in the navigation

Specified by:

hasfilterbefore in class FilterElement<TimePeriod>

Returns:

true if before

hasfilterafter

protected boolean hasfilterafter()

Description copied from class: FilterElement

A filter is considered as 'after' if it is a filter after the query was performed

Specified by:

hasfilterafter in class FilterElement<TimePeriod>

Returns:

true if after

writeFilterInDataGathering

public void writeFilterInDataGathering(SourceGenerator sg,
                                       java.lang.String prefixforlinkandchild,
                                       DataObjectDefinition reportroot,
                                       java.lang.String reportname)
                                throws java.io.IOException

Description copied from class: FilterElement

writes the filter code in the data gathering phase of the report

Specified by:

writeFilterInDataGathering in class FilterElement<TimePeriod>

Parameters:

sg - source generator

prefixforlinkandchild - step suffix

reportroot - root object of the report

reportname - report name

Throws:

java.io.IOException - if anything bad happens while writing the file

getBlankValue

protected java.lang.String getBlankValue()

Specified by:

getBlankValue in class FilterElement<TimePeriod>

Returns:

get the blank value for the filter (typically empty object, null string...) in java code for code generation