org.openlowcode.design.data

Class DataAccessMethod

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.DataAccessMethod

All Implemented Interfaces:

NamedInterface

public class DataAccessMethod
extends Named

A Data Access Method is a method that allows access to data of the property. It can be called from actions and utilities

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
DataAccessMethod(java.lang.String name, ArgumentContent output, boolean acceptquerycondition) Create a data access method specifying the output
DataAccessMethod(java.lang.String name, ArgumentContent output, boolean acceptquerycondition, boolean masstreatment) Create a data access method

Method Summary

Modifier and Type	Method and Description
void	addInputArgument(MethodArgument argument)
java.lang.String	generateMethodArguments(boolean securityarguments) generates the method unitary arguments, with potentially security arguments
java.lang.String	generateMethodArgumentsForMassive() generates the methods arguments for massive processing
java.lang.String	generateMethodInternalArguments(Property<?> thisproperty, java.lang.String classname, boolean startwithcomma) generates the method internal argument for unitary processing to be used for code generation
java.lang.String	generateMethodInternalArgumentsForMassive(Property<?> thisproperty, java.lang.String classname, boolean startwithcomma) generates the method internal argument for massive
java.lang.String	generateMethodInternalArgumentsForMassive(Property<?> thisproperty, java.lang.String classname, boolean startwithcomma, boolean definitionstuff) generates the method internal argument for massive to be used for code generation
java.lang.String	generateMethodPassThroughArguments() generates the arguments for arguments pass-through.
MethodArgument	getImplicitobjectmethod()
MethodArgument	getInputArgument(int index) gets the input agument at the given index
int	getInputAttributeNumber()
ArgumentContent	getoutputargument()
boolean	isAcceptquerycondition()
boolean	isMassive()
boolean	isStatic() A method should be static if it does not have a single object as an input attribute
boolean	needPropertyExtractor()
void	setNeedForPropertyExtractor() sets that the data access method needs a property extractor

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, equals, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

DataAccessMethod

public DataAccessMethod(java.lang.String name,
                        ArgumentContent output,
                        boolean acceptquerycondition)

Create a data access method specifying the output

Parameters:

name - name of the method. Should be unique amongst all method properties of the application

output - output of the method

acceptquerycondition - specifies if the method accepts an additional query condition method (example: a select does not "start" from an object)

DataAccessMethod

public DataAccessMethod(java.lang.String name,
                        ArgumentContent output,
                        boolean acceptquerycondition,
                        boolean masstreatment)

Create a data access method

Parameters:

name - name of the method. Should be unique amongst all method properties of the application

output - output of the method

acceptquerycondition - specifies if the method accepts an additional query condition method (example: a select does not "start" from an object)

masstreatment - true if mass treatment is implemented for this method. Mass treatment allows to treat efficiently a batch of objects

Method Detail

isAcceptquerycondition

public boolean isAcceptquerycondition()

Returns:

true if the method accepts a query condition. This is mostly true for data access methods performing queries

needPropertyExtractor

public boolean needPropertyExtractor()

Returns:

true if a property extractor is needed. typically, this is required when the data access method uses a related property

setNeedForPropertyExtractor

public void setNeedForPropertyExtractor()

sets that the data access method needs a property extractor

isMassive

public boolean isMassive()

Returns:

true if method implements massive treatment

getImplicitobjectmethod

public MethodArgument getImplicitobjectmethod()

Returns:

the implicit argument for the method (if method is not static)

addInputArgument

public void addInputArgument(MethodArgument argument)

Parameters:

argument - adds an input argument

isStatic

public boolean isStatic()

A method should be static if it does not have a single object as an input attribute

Returns:

true if the method should be implemented as static.

getoutputargument

public ArgumentContent getoutputargument()

Returns:

get the output of the current method

getInputAttributeNumber

public int getInputAttributeNumber()

Returns:

get the number of input attributes

getInputArgument

public MethodArgument getInputArgument(int index)

gets the input agument at the given index

Parameters:

index - an integer between 0 (included) and getInputAttributeNumber (excluded)

Returns:

the input method argument at the given index

generateMethodInternalArgumentsForMassive

public java.lang.String generateMethodInternalArgumentsForMassive(Property<?> thisproperty,
                                                                  java.lang.String classname,
                                                                  boolean startwithcomma)

generates the method internal argument for massive

Parameters:

thisproperty - relevant property (parent)

classname - class name of the data object

startwithcomma - if true, start with a comma (if there is another argument before)

Returns:

the method internal argument

generateMethodInternalArgumentsForMassive

public java.lang.String generateMethodInternalArgumentsForMassive(Property<?> thisproperty,
                                                                  java.lang.String classname,
                                                                  boolean startwithcomma,
                                                                  boolean definitionstuff)

generates the method internal argument for massive to be used for code generation

Parameters:

thisproperty - relevant property (parent)

classname - class name of the data object

startwithcomma - if true, start with a comma (if there is another argument before)

definitionstuff - true if part of object definition, false if part of object run-time

Returns:

the method internal argument

generateMethodInternalArguments

public java.lang.String generateMethodInternalArguments(Property<?> thisproperty,
                                                        java.lang.String classname,
                                                        boolean startwithcomma)

generates the method internal argument for unitary processing to be used for code generation

Parameters:

thisproperty - relevant property (parent)

classname - class name of the data object

startwithcomma - if true, start with a comma (if there is another

Returns:

the method arguments

generateMethodArgumentsForMassive

public java.lang.String generateMethodArgumentsForMassive()

generates the methods arguments for massive processing

Returns:

methods arguments

generateMethodPassThroughArguments

public java.lang.String generateMethodPassThroughArguments()

generates the arguments for arguments pass-through. This is used for methods with security

Returns:

the arguments for method pass-through

generateMethodArguments

public java.lang.String generateMethodArguments(boolean securityarguments)

generates the method unitary arguments, with potentially security arguments

Parameters:

securityarguments - if true, generates with security arguments

Returns:

method unitary arguments