Module io.github.mmm.property

Package io.github.mmm.property.criteria

Class CriteriaFormatter

java.lang.Object

io.github.mmm.property.criteria.CriteriaFormatter

All Implemented Interfaces:

CriteriaVisitor

public class CriteriaFormatter
extends Object
implements CriteriaVisitor

A formatter to format CriteriaExpressions to database specific notation (e.g. SQL) as string to a given Appendable (see out()). See of* methods to create instances. For specific database dialects simply create a subclass of this CriteriaFormatter.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final io.github.mmm.base.io.AppendableWriter	out	Appendable where to append the SQL.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CriteriaFormatter()	The constructor using inline CriteriaParameters.
protected	CriteriaFormatter(CriteriaParameters parameters, io.github.mmm.base.io.AppendableWriter out)	The constructor.

Method Summary

Modifier and Type	Method	Description
protected String	convertLikePattern(String glob)
LikePatternSyntax	getLikeSyntaxSource()
LikePatternSyntax	getLikeSyntaxTarget()
CriteriaParameters	getParameters()
static boolean	isUseBrackets(CriteriaExpression<?> expression, CriteriaExpression<?> parent)
static CriteriaFormatter	of(CriteriaParameters parameters, io.github.mmm.base.io.AppendableWriter appendable)
static CriteriaFormatter	of(CriteriaParameters parameters, Appendable appendable)
static CriteriaFormatter	ofIndexedParameters()
static CriteriaFormatter	ofIndexedParameters(io.github.mmm.base.io.AppendableWriter appendable)
static CriteriaFormatter	ofIndexedParameters(Appendable appendable)
static CriteriaFormatter	ofNamedParameters(io.github.mmm.base.io.AppendableWriter appendable, boolean merge)
static CriteriaFormatter	ofNamedParameters(Appendable appendable)
static CriteriaFormatter	ofNamedParameters(Appendable appendable, boolean merge)
void	onAlias(String alias)	Writes the given alias.
CriteriaFormatter	onExpression(CriteriaExpression<?> expression, CriteriaExpression<?> parent)
void	onLiteral(Literal<?> literal, int i, CriteriaExpression<?> parent)
void	onOperator(CriteriaOperator operator)
void	onOrdering(CriteriaOrdering ordering)
void	onProjectionProperty(ProjectionProperty<?> arg, int i, CriteriaExpression<?> parent)
void	onPropertyPath(io.github.mmm.value.PropertyPath<?> property, int i, CriteriaExpression<?> parent)
void	onUndefinedArg(io.github.mmm.value.CriteriaObject<?> arg, int i, CriteriaExpression<?> parent)
io.github.mmm.base.io.AppendableWriter	out()
void	setLikeSyntaxSource(LikePatternSyntax likeSyntaxSource)
void	setLikeSyntaxTarget(LikePatternSyntax likeSyntaxTarget)
String	toString()
protected void	write(String text)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.mmm.property.criteria.CriteriaVisitor

onArg, onExpression

Field Details

out

protected final io.github.mmm.base.io.AppendableWriter out

Appendable where to append the SQL.

Constructor Details

CriteriaFormatter

public CriteriaFormatter()

The constructor using inline CriteriaParameters.
ATTENTION: Only use this for testing or debugging (e.g. in toString()) to avoid SQL-injection security vulnerabilities.

CriteriaFormatter

protected CriteriaFormatter(CriteriaParameters parameters,
 io.github.mmm.base.io.AppendableWriter out)

The constructor.

Parameters:

parameters - the CriteriaParameters or null for default (inline). ATTENTION: Use null only for testing or debugging (e.g. in toString()) to avoid SQL-injection security vulnerabilities.

out - the Appendable to write to.

Method Details

getLikeSyntaxSource

public LikePatternSyntax getLikeSyntaxSource()

Returns:

likeSyntaxSource

setLikeSyntaxSource

public void setLikeSyntaxSource(LikePatternSyntax likeSyntaxSource)

Parameters:

likeSyntaxSource - new value of getLikeSyntaxSource().

getLikeSyntaxTarget

public LikePatternSyntax getLikeSyntaxTarget()

Returns:

likeSyntaxTarget

setLikeSyntaxTarget

public void setLikeSyntaxTarget(LikePatternSyntax likeSyntaxTarget)

Parameters:

likeSyntaxTarget - new value of getLikeSyntaxTarget().

write

protected void write(String text)

Parameters:

text - the database syntax to append.

out

public io.github.mmm.base.io.AppendableWriter out()

Returns:

the AppendableWriter wrapping the Appendable to write to.

getParameters

public CriteriaParameters getParameters()

Returns:

the CriteriaParameters.

onExpression

public CriteriaFormatter onExpression(CriteriaExpression<?> expression,
 CriteriaExpression<?> parent)

Specified by:

onExpression in interface CriteriaVisitor

Parameters:

expression - the CriteriaExpression to visit.

parent - the parent CriteriaExpression or null if expression is the root CriteriaExpression.

Returns:

this visitor itself for fluent API calls.

isUseBrackets

public static boolean isUseBrackets(CriteriaExpression<?> expression,
 CriteriaExpression<?> parent)

Parameters:

expression - the CriteriaExpression to consider enclosing in brackets.

parent - the parent CriteriaExpression using expression as argument.

Returns:

true if expression needs to be enclosed in brackets, false otherwise.

onOperator

public void onOperator(CriteriaOperator operator)

Specified by:

onOperator in interface CriteriaVisitor

Parameters:

operator - the CriteriaOperator to visit.

onPropertyPath

public void onPropertyPath(io.github.mmm.value.PropertyPath<?> property,
 int i,
 CriteriaExpression<?> parent)

Specified by:

onPropertyPath in interface CriteriaVisitor

Parameters:

property - the PropertyPath to visit.

i - the index of arg in the arguments.

parent - the parent CriteriaExpression to owning the given PropertyPath.

See Also:

• CriteriaVisitor.onArg(CriteriaObject, int, CriteriaExpression)

onProjectionProperty

public void onProjectionProperty(ProjectionProperty<?> arg,
 int i,
 CriteriaExpression<?> parent)

Specified by:

onProjectionProperty in interface CriteriaVisitor

Parameters:

arg - the ProjectionProperty.

i - the index of arg in the arguments.

parent - the parent CriteriaExpression owning the given arg.

onAlias

public void onAlias(String alias)

Writes the given alias. Override to write "AS " as prefix if required or desired.

Parameters:

alias - the alias to write.

onLiteral

public void onLiteral(Literal<?> literal,
 int i,
 CriteriaExpression<?> parent)

Specified by:

onLiteral in interface CriteriaVisitor

Parameters:

literal - the Literal to visit.

i - the index of arg in the arguments.

parent - the parent CriteriaExpression to owning the given Literal.

See Also:

• CriteriaVisitor.onArg(CriteriaObject, int, CriteriaExpression)

convertLikePattern

protected String convertLikePattern(String glob)

Parameters:

glob - the literal value for a LIKE expression assumed in glob-syntax.

Returns:

the given glob String converted to LIKE pattern.

onUndefinedArg

public void onUndefinedArg(io.github.mmm.value.CriteriaObject<?> arg,
 int i,
 CriteriaExpression<?> parent)

Specified by:

onUndefinedArg in interface CriteriaVisitor

Parameters:

arg - the undefined arg (if no Literal, PropertyPath or CriteriaExpression).

i - the index of arg in the arguments.

parent - the parent CriteriaExpression owning the given arg.

See Also:

• CriteriaVisitor.onArg(CriteriaObject, int, CriteriaExpression)

onOrdering

public void onOrdering(CriteriaOrdering ordering)

Parameters:

ordering - the CriteriaOrdering to format to append.

toString

public String toString()

Overrides:

toString in class Object

of

public static CriteriaFormatter of(CriteriaParameters parameters,
 Appendable appendable)

Parameters:

parameters - the CriteriaParameters.

appendable - the Appendable where to write the database syntax to.

Returns:

the new CriteriaFormatter.

of

public static CriteriaFormatter of(CriteriaParameters parameters,
 io.github.mmm.base.io.AppendableWriter appendable)

Parameters:

parameters - the CriteriaParameters.

appendable - the AppendableWriter where to write the database syntax to.

Returns:

the new CriteriaFormatter.

ofIndexedParameters

public static CriteriaFormatter ofIndexedParameters()

Returns:

the new CriteriaFormatter using indexed parameters.

ofIndexedParameters

public static CriteriaFormatter ofIndexedParameters(Appendable appendable)

Parameters:

appendable - the Appendable where to write the database syntax to.

Returns:

the new CriteriaFormatter using indexed parameters.

ofIndexedParameters

public static CriteriaFormatter ofIndexedParameters(io.github.mmm.base.io.AppendableWriter appendable)

Parameters:

appendable - the AppendableWriter where to write the database syntax to.

Returns:

the new CriteriaFormatter using indexed parameters.

ofNamedParameters

public static CriteriaFormatter ofNamedParameters(Appendable appendable)

Parameters:

appendable - the Appendable where to write the database syntax to.

Returns:

the new CriteriaFormatter using named parameters.

ofNamedParameters

public static CriteriaFormatter ofNamedParameters(Appendable appendable,
 boolean merge)

Parameters:

appendable - the Appendable where to write the database syntax to.

merge - the merge flag.

Returns:

the new CriteriaFormatter using named parameters.

ofNamedParameters

public static CriteriaFormatter ofNamedParameters(io.github.mmm.base.io.AppendableWriter appendable,
 boolean merge)

Parameters:

appendable - the AppendableWriter where to write the database syntax to.

merge - the merge flag.

Returns:

the new CriteriaFormatter using named parameters.