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

Class Alias<E>

java.lang.Object

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

net.sf.mmm.util.query.base.path.AbstractPathRoot<E>

net.sf.mmm.util.query.base.path.Alias<E>

Type Parameters:

E - the generic type of the type of this Alias.

All Implemented Interfaces:

AttributeReadName, EntityAlias<E>, PathFactory, PathRoot<E>

public class Alias<E>
extends AbstractPathRoot<E>
implements EntityAlias<E>

This class represents an Alias used in a FROM block of an SQL statement.

Since:

8.0.0

Author:

hohwille

Field Summary

Fields

Modifier and Type	Field and Description
private Class<?>	entityType
private String	name
private E	prototype
private Class<E>	resultType
private String	source

Constructor Summary

Constructors

Constructor and Description
Alias(String source) The constructor.
Alias(String source, String name) The constructor.
Alias(String source, String name, Class<?> entityType, E prototype, Class<E> resultType) The constructor.
Alias(String source, String name, Class<E> type) The constructor.
Alias(String source, String name, E prototype) The constructor.

Method Summary

Modifier and Type	Method and Description
Alias<E>	as(String aliasName)
Class<?>	getEntityType()
String	getName()
E	getPrototype()
Class<E>	getResultType()
String	getSource()
static <E extends Bean> Alias<E>	ofBean(E prototype)
static <E extends Bean> Alias<E>	ofBean(E prototype, String alias)
String	toString()

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, wait, wait, wait

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

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

Field Detail

source

private final String source

name

private final String name

prototype

private final E prototype

entityType

private final Class<?> entityType

resultType

private final Class<E> resultType

Constructor Detail

Alias

public Alias(String source)

The constructor.

Parameters:

source - - see getSource().

Alias

public Alias(String source,
             String name)

The constructor.

Parameters:

source - - see getSource().

name - - see getName().

Alias

public Alias(String source,
             String name,
             Class<E> type)

The constructor.

Parameters:

source - - see getSource().

name - - see getName().

type - - see getEntityType().

Alias

public Alias(String source,
             String name,
             E prototype)

The constructor.

Parameters:

source - - see getSource().

name - - see getName().

prototype - - see getPrototype().

Alias

public Alias(String source,
             String name,
             Class<?> entityType,
             E prototype,
             Class<E> resultType)

The constructor.

Parameters:

source - - see getSource().

name - - see getName().

entityType - - see getEntityType().

prototype - - see getPrototype().

resultType - - see getResultType().

Method Detail

getSource

public String getSource()

Specified by:

getSource in interface EntityAlias<E>

Returns:

the actual source of this EntityAlias. Typically the name of a table, entity, class, etc. Shall NOT be null.

getName

public String getName()

Specified by:

getName in interface AttributeReadName

Specified by:

getName in interface EntityAlias<E>

Returns:

the alias name of this EntityAlias (what is "alias" in "SELECT FROM Foo AS alias").

getPrototype

public E getPrototype()

Specified by:

getPrototype in interface EntityAlias<E>

Specified by:

getPrototype in interface PathRoot<E>

Returns:

optional the prototype of this source. May be null.

getEntityType

public Class<?> getEntityType()

Specified by:

getEntityType in interface EntityAlias<E>

Returns:

the optional Class reflecting the internal entity of the source. It is not bound to <E> as the internal entity does not necessarily have to be the queried result type. May be null.

getResultType

public Class<E> getResultType()

Specified by:

getResultType in interface EntityAlias<E>

Returns:

the optional Class reflecting the external result when this EntityAlias gets queried.

as

public Alias<E> as(String aliasName)

Specified by:

as in interface EntityAlias<E>

Parameters:

aliasName - the new alias name.

Returns:

a copy of this Alias with the given alias name.

toString

public String toString()

Overrides:

toString in class Object

ofBean

public static <E extends Bean> Alias<E> ofBean(E prototype)

Type Parameters:

E - the generic type of the Bean.

Parameters:

prototype - the prototype of the Bean to use as prototype.

Returns:

the new instance of Alias.

ofBean

public static <E extends Bean> Alias<E> ofBean(E prototype,
                                               String alias)

Type Parameters:

E - the generic type of the Bean.

Parameters:

prototype - the prototype of the Bean to use as prototype.

alias - the getName().

Returns:

the new instance of Alias.