org.openlowcode.design.data

Class DataObjectDefinitionSearchPagesAndActions

java.lang.Object

org.openlowcode.design.data.DataObjectDefinitionSearchPagesAndActions

public class DataObjectDefinitionSearchPagesAndActions
extends java.lang.Object

This class regroups methods to generate search actions and pages

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
DataObjectDefinitionSearchPagesAndActions(DataObjectDefinition object) creates a utility class to generate search actions and pages for the given data object

Method Summary

Modifier and Type	Method and Description
static void	generateLaunchSearchActionToFile(java.lang.String name, SourceGenerator sg, Module module)
protected ActionDefinition	generateSearchAction() general the search action for the data object
protected ActionDefinition	generateSearchActionForLeftObjectLink(LinkObject<?,?> linkobject) generate the search action looking for potential left object while building a link
void	generateSearchActionForLeftObjectLinkToFile(SourceGenerator sg, Module module) generates the search action looking for a potential left object for a link
protected ActionDefinition	generateSearchActionForRightObjectAutolink(AutolinkObject<?> linkobject) generates a search action for potential right objects to build an auto-link
void	generateSearchActionForRightObjectAutolinkToFile(SourceGenerator sg, Module module) generates the source code of search action for a potential right object for an auto-link
protected ActionDefinition	generateSearchActionForRightObjectLink(LinkObject<?,?> linkobject) generates search action looking for a potential right object
void	generateSearchActionForRightObjectLinkToFile(SourceGenerator sg, Module module) Generates the search action source code for a potential right object
void	generateSearchActionToFile(SourceGenerator sg, Module module) generates the source code for the normal search action for a data object
ActionDefinition	generateSearchActionWithParent(LinkObject<?,?> linkobject, LinkedToParent<?> rightobjectparentproperty) generates a search action for all right objects with the same parents as the left object
void	generateSearchActionWithParentToFile(SourceGenerator sg, Module module) generates the source code of the search action for a potential right object to build a link
PageDefinition	generateSearchPage()
void	generateSearchPageToFile(SourceGenerator sg, Module module) generates the source code for the search page

Methods inherited from class java.lang.Object

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

Constructor Detail

DataObjectDefinitionSearchPagesAndActions

public DataObjectDefinitionSearchPagesAndActions(DataObjectDefinition object)

creates a utility class to generate search actions and pages for the given data object

Parameters:

object - data object

Method Detail

generateSearchActionForRightObjectLink

protected ActionDefinition generateSearchActionForRightObjectLink(LinkObject<?,?> linkobject)

generates search action looking for a potential right object

Parameters:

linkobject - link object property

Returns:

the search action for right object

generateSearchActionForLeftObjectLink

protected ActionDefinition generateSearchActionForLeftObjectLink(LinkObject<?,?> linkobject)

generate the search action looking for potential left object while building a link

Parameters:

linkobject - link object property

Returns:

the search action for right object

generateSearchActionForRightObjectAutolink

protected ActionDefinition generateSearchActionForRightObjectAutolink(AutolinkObject<?> linkobject)

generates a search action for potential right objects to build an auto-link

Parameters:

linkobject - autolink object property

Returns:

the action definition

generateSearchAction

protected ActionDefinition generateSearchAction()

general the search action for the data object

Returns:

the search action

generateSearchActionWithParentToFile

public void generateSearchActionWithParentToFile(SourceGenerator sg,
                                                 Module module)
                                          throws java.io.IOException

generates the source code of the search action for a potential right object to build a link

Parameters:

sg - source generator

module - parent module

Throws:

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

generateSearchActionForRightObjectLinkToFile

public void generateSearchActionForRightObjectLinkToFile(SourceGenerator sg,
                                                         Module module)
                                                  throws java.io.IOException

Generates the search action source code for a potential right object

Parameters:

sg - source generator

module - parent module

Throws:

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

generateSearchActionForLeftObjectLinkToFile

public void generateSearchActionForLeftObjectLinkToFile(SourceGenerator sg,
                                                        Module module)
                                                 throws java.io.IOException

generates the search action looking for a potential left object for a link

Parameters:

sg - source generator

module - parent module

Throws:

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

generateSearchActionForRightObjectAutolinkToFile

public void generateSearchActionForRightObjectAutolinkToFile(SourceGenerator sg,
                                                             Module module)
                                                      throws java.io.IOException

generates the source code of search action for a potential right object for an auto-link

Parameters:

sg - source generator

module - parent module

Throws:

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

generateSearchActionToFile

public void generateSearchActionToFile(SourceGenerator sg,
                                       Module module)
                                throws java.io.IOException

generates the source code for the normal search action for a data object

Parameters:

sg - source generator

module - parent module

Throws:

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

generateSearchPage

public PageDefinition generateSearchPage()

Returns:

the search page for the given data object
Note: the search page does not have any search attribute as input as the search attributes are entered on the search page

generateSearchPageToFile

public void generateSearchPageToFile(SourceGenerator sg,
                                     Module module)
                              throws java.io.IOException

generates the source code for the search page

Parameters:

sg - source generator

module - parent module

Throws:

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

generateSearchActionWithParent

public ActionDefinition generateSearchActionWithParent(LinkObject<?,?> linkobject,
                                                       LinkedToParent<?> rightobjectparentproperty)

generates a search action for all right objects with the same parents as the left object

Parameters:

linkobject - property of the link between left and right objects

rightobjectparentproperty - the parent property on the right object to consider

Returns:

the action definition class of the action

generateLaunchSearchActionToFile

public static void generateLaunchSearchActionToFile(java.lang.String name,
                                                    SourceGenerator sg,
                                                    Module module)
                                             throws java.io.IOException

Parameters:

name - name of the data object

sg - source generator

module - parent module

Throws:

java.io.IOException - if anyting bad happens while writing the source code