net.sf.mmm.util.query.api.path

Interface EntityAlias<E>

Type Parameters:

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

All Superinterfaces:

AttributeReadName, PathFactory, PathRoot<E>

All Known Implementing Classes:

Alias

public interface EntityAlias<E>
extends PathRoot<E>

This is the interface for an EntityAlias used in an SQL statement e.g. inside a a FROM block.

Since:

8.0.0

Author:

hohwille

See Also:

Alias

Method Summary

Modifier and Type	Method and Description
Alias<E>	as(String aliasName)
Class<?>	getEntityType()
String	getName()
E	getPrototype()
Class<E>	getResultType()
String	getSource()

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

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

Method Detail

getSource

String getSource()

Returns:

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

getName

String getName()

Specified by:

getName in interface AttributeReadName

Returns:

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

getEntityType

Class<?> getEntityType()

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

Class<E> getResultType()

Returns:

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

getPrototype

E getPrototype()

Specified by:

getPrototype in interface PathRoot<E>

Returns:

optional the prototype of this source. May be null.

as

Alias<E> as(String aliasName)

Parameters:

aliasName - the new alias name.

Returns:

a copy of this Alias with the given alias name.