net.sf.mmm.util.query.base.path

Class PathImpl<V>

java.lang.Object

net.sf.mmm.util.query.base.path.AbstractPathFactory

net.sf.mmm.util.query.base.path.PathImpl<V>

Type Parameters:

V - the generic type of the property value identified by this path.

All Implemented Interfaces:

AttributeReadName, AttributeReadValue<V>, PropertyPath<V>, Argument<V>, Path<V>, PathFactory, AbstractArgument<V>

Direct Known Subclasses:

BooleanPathImpl, CollectionPathImpl, ComparablePathImpl, EntityBeanPathImpl, MapPathImpl, StringPathImpl

public class PathImpl<V>
extends AbstractPathFactory
implements Path<V>, AbstractArgument<V>

This is the implementation of Path.

Since:

8.0.0

Author:

hohwille

Field Summary

Fields

Modifier and Type	Field and Description
private static Bean	AGGREGATE_FUNCTION_BEAN
protected static IntegerProperty	AVG_PROPERTY The property for the avg aggregate function to calculate the average value.
protected static IntegerProperty	MAX_PROPERTY The property for the max aggregate function to calculate the maximum value.
protected static IntegerProperty	MIN_PROPERTY The property for the min aggregate function to calculate the minimum value.
private PathImpl<?>	parent
private ReadableProperty<?>	property
private PathRoot<?>	root
private static char	SEPARATOR The character that separates the segments of a path.
protected static IntegerProperty	SIZE_PROPERTY The property for the size aggregate function on a Collection.
protected static IntegerProperty	SUM_PROPERTY The property for the size aggregate function on a Collection.

Constructor Summary

Constructors

Constructor and Description
PathImpl(PathImpl<?> parent, ReadableProperty<?> property) The constructor.
PathImpl(PathRoot<?> root, ReadableProperty<?> property) The constructor.

Method Summary

Modifier and Type	Method and Description
private void	fail(String expectedType, Bean bean)
void	format(Function<AttributeReadName,String> segmentFormatter, StringBuilder buffer)
PathImpl<?>	getParent()
String	getParentName(boolean omitRootAlias)
ReadableProperty<?>	getProperty()
PathRoot<?>	getRoot()
V	getValue() This method gets the value of this object.
Path<V>	getValuePath()
boolean	isConstant()
private static boolean	isEmpty(String string)
private boolean	verify()
private void	verifyBeanProperty(Bean bean, ReadableProperty<?> prop)

Methods inherited from class net.sf.mmm.util.query.base.path.AbstractPathFactory

to, to, to, to, to, to, to, to

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.query.api.path.Path

getName

Methods inherited from interface net.sf.mmm.util.query.api.path.PathFactory

to, to, to, to, to, to, to, to

Methods inherited from interface net.sf.mmm.util.query.base.argument.AbstractArgument

eq, eq, exp, exp, exp, exp, expRight, in, in, isNotNull, isNull, neq, neq, notIn, notIn

Methods inherited from interface net.sf.mmm.util.query.api.argument.Argument

evaluate

Field Detail

AGGREGATE_FUNCTION_BEAN

private static final Bean AGGREGATE_FUNCTION_BEAN

SIZE_PROPERTY

protected static final IntegerProperty SIZE_PROPERTY

The property for the size aggregate function on a Collection.

AVG_PROPERTY

protected static final IntegerProperty AVG_PROPERTY

The property for the avg aggregate function to calculate the average value.

MAX_PROPERTY

protected static final IntegerProperty MAX_PROPERTY

The property for the max aggregate function to calculate the maximum value.

MIN_PROPERTY

protected static final IntegerProperty MIN_PROPERTY

The property for the min aggregate function to calculate the minimum value.

SUM_PROPERTY

protected static final IntegerProperty SUM_PROPERTY

The property for the size aggregate function on a Collection.

SEPARATOR

private static char SEPARATOR

The character that separates the segments of a path.

root

private final PathRoot<?> root

parent

private final PathImpl<?> parent

property

private final ReadableProperty<?> property

Constructor Detail

PathImpl

public PathImpl(PathRoot<?> root,
                ReadableProperty<?> property)

The constructor.

Parameters:

root - - getRoot().

property - - see getProperty().

PathImpl

public PathImpl(PathImpl<?> parent,
                ReadableProperty<?> property)

The constructor.

Parameters:

parent - - getParent().

property - - see getProperty().

Method Detail

verify

private boolean verify()

fail

private void fail(String expectedType,
                  Bean bean)

verifyBeanProperty

private void verifyBeanProperty(Bean bean,
                                ReadableProperty<?> prop)

getRoot

public PathRoot<?> getRoot()

Specified by:

getRoot in interface Path<V>

Returns:

the root of this Path. Will e.g. be an Alias or a Variable and NOT an instance of Path.

getProperty

public ReadableProperty<?> getProperty()

Returns:

the property.

getParent

public PathImpl<?> getParent()

Returns:

the parent

format

public void format(Function<AttributeReadName,String> segmentFormatter,
                   StringBuilder buffer)

Specified by:

format in interface Path<V>

Parameters:

segmentFormatter - a Function used to format a segment of this Path to its String representation. This formatter will receive instances of PathRoot or ReadableProperty.

buffer - the StringBuilder where to append the resulting String representation of this Path.

See Also:

Path.getName()

isEmpty

private static boolean isEmpty(String string)

getParentName

public String getParentName(boolean omitRootAlias)

Parameters:

omitRootAlias - - true if the root shall be omitted in case it is an EntityAlias, false otherwise (the default for Path.getName()).

Returns:

the name of parent or root.

getValuePath

public Path<V> getValuePath()

Specified by:

getValuePath in interface Argument<V>

Returns:

the Path of this builder. Will be null if value is NOT null and vice versa.

getValue

public V getValue()

Description copied from interface: AttributeReadValue

This method gets the value of this object.

Specified by:

getValue in interface AttributeReadValue<V>

Specified by:

getValue in interface Argument<V>

Returns:

the value of this object. May be null unless otherwise stated.

isConstant

public boolean isConstant()

Specified by:

isConstant in interface Argument<V>

Returns:

true if this is a literal value Argument, false otherwise.