org.openlowcode.design.advanced

Class FilterElement<E>

java.lang.Object

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

Type Parameters:

E - the object on which the filter element is set

Direct Known Subclasses:

ChoiceFilterElement, FilterElementLink, TimePeriodFilterElement

public abstract class FilterElement<E>
extends java.lang.Object

A filter element will limit data in the report. The filter can be set as hard-coded, or as values provided in the design phase.

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	fatherisroot
protected SmartReportNodeLink	linktoparent

Constructor Summary

Constructors

Constructor and Description
FilterElement(boolean hardcoded) Creates a filter element

Method Summary

Modifier and Type	Method and Description
abstract 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 abstract java.lang.String	getBlankValue()
abstract java.lang.String[]	getImportClasses() provides the import classes to be put in the page
abstract java.lang.String[]	getImportClassesForAction(java.lang.String reportname) provides he import classes to be put in the action
abstract DataObjectDefinition	getParent()
protected abstract boolean	hasfilterafter() A filter is considered as 'after' if it is a filter after the query was performed
protected abstract 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
boolean	isHardCoded()
void	setContext(boolean fatherisroot, SmartReportNodeLink linktoparent) sets the context of this filter element
abstract void	writeFilterCriteria(SourceGenerator sg, java.lang.String reportname) The filter criteria for the page of the smart report
abstract void	writeFilterInDataGathering(SourceGenerator sg, java.lang.String stepsuffix, DataObjectDefinition reportroot, java.lang.String reportname) writes the filter code in the data gathering phase of the report

Methods inherited from class java.lang.Object

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

Field Detail

fatherisroot

protected boolean fatherisroot

linktoparent

protected SmartReportNodeLink linktoparent

Constructor Detail

FilterElement

public FilterElement(boolean hardcoded)

Creates a filter element

Parameters:

hardcoded - if true, the filter element will be build by the developer, not by the framework

Method Detail

setContext

public void setContext(boolean fatherisroot,
                       SmartReportNodeLink linktoparent)

sets the context of this filter element

Parameters:

fatherisroot - true if the filter is done on a node directly child to the parent. This changes a little bit the generated code

linktoparent - link from parent to current node

isHardCoded

public boolean isHardCoded()

Returns:

true if the filter is hardcoded

getParent

public abstract DataObjectDefinition getParent()

Returns:

the parent of the filter (current data object node)

getArgumentContent

public abstract 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

Parameters:

suffix - suffix of the current node in the report

Returns:

the argument content

writeFilterCriteria

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

The filter criteria for the page of the smart report

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 abstract java.lang.String[] getImportClasses()

provides the import classes to be put in the page

Returns:

an array of import statements

getImportClassesForAction

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

provides he import classes to be put in the action

Parameters:

reportname - name of the report

Returns:

an array of import statements

hasfilterbefore

protected abstract 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

Returns:

true if before

hasfilterafter

protected abstract boolean hasfilterafter()

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

Returns:

true if after

writeFilterInDataGathering

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

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

Parameters:

sg - source generator

stepsuffix - 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 abstract java.lang.String getBlankValue()

Returns:

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