AbstractFeature (JavaDocs for mmm-all dev-SNAPSHOT)

java.lang.Object
- net.sf.mmm.util.query.base.feature.AbstractFeature

All Implemented Interfaces:

Comparable<AbstractFeature>, StatementFeature

Direct Known Subclasses:

FeatureAndFromImpl, FeatureGroupByImpl, FeatureHavingImpl, FeatureLetImpl, FeatureOrderByImpl, FeaturePagingImpl, FeatureSetImpl, FeatureUpsertImpl, FeatureWhereImpl
```
public abstract class AbstractFeature
extends Object
implements StatementFeature, Comparable<AbstractFeature>
```
This is the abstract base implementation of StatementFeature.

Since:

8.0.0

Author:

hohwille

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`SORT_INDEX_AND_FROM` `Sort index` for `FeatureAndFromImpl`.
`protected static int`	`SORT_INDEX_FETCHPLAN` `Sort index` for `FeatureFetchplanImpl`.
`protected static int`	`SORT_INDEX_GROUP_BY` `Sort index` for `FeatureGroupByImpl`.
`protected static int`	`SORT_INDEX_HAVING` `Sort index` for `FeatureHavingImpl`.
`protected static int`	`SORT_INDEX_LET` `Sort index` for `FeatureLetImpl`.
`protected static int`	`SORT_INDEX_LOCK` `Sort index` for `FeatureLockImpl`.
`protected static int`	`SORT_INDEX_NOCACHE` `Sort index` for `FeatureNoCacheImpl`.
`protected static int`	`SORT_INDEX_ORDER_BY` `Sort index` for `FeatureOrderByImpl`.
`protected static int`	`SORT_INDEX_PAGING` `Sort index` for `FeaturePagingImpl`.
`protected static int`	`SORT_INDEX_PARALLEL` `Sort index` for `FeatureParallelImpl`.
`protected static int`	`SORT_INDEX_SET` `Sort index` for `FeatureSetImpl`.
`protected static int`	`SORT_INDEX_TIMEOUT` `Sort index` for `FeatureTimeoutImpl`.
`protected static int`	`SORT_INDEX_UNWIND` `Sort index` for `FeatureUnwindImpl`.
`protected static int`	`SORT_INDEX_UPSERT` `Sort index` for `FeatureUpsertImpl`.
`protected static int`	`SORT_INDEX_WHERE` `Sort index` for `FeatureWhereImpl`.
`private int`	`sortIndex`
`private AbstractStatement<?,?>`	`statement`

Constructor Summary

Constructors
Constructor and Description

AbstractFeature(int sortIndex)
The constructor.

Constructors
Constructor and Description
`AbstractFeature(int sortIndex)` The constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected <V> Argument<V>`	`asArg(PropertyPath<V> path)`
`protected <V> Path<V>`	`asPath(PropertyPath<V> path)`
`abstract void`	`build(SqlBuilder builder)`
`protected Expression`	`combine(Expression expression, Conjunction conjunction, Expression... newExpressions)` Combines the given `Expression` with the given array of new `Expression`s using the given `Conjunction`.
`int`	`compareTo(AbstractFeature o)`
`static <F extends AbstractFeature> F`	`create(Class<F> featureClass)`
`protected SqlDialect`	`getDialect()`
`int`	`getSortIndex()`
`AbstractStatement<?,?>`	`getStatement()`
`void`	`setStatement(AbstractStatement<?,?> statement)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SORT_INDEX_AND_FROM
```
protected static final int SORT_INDEX_AND_FROM
```
    Sort index for FeatureAndFromImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_SET
```
protected static final int SORT_INDEX_SET
```
    Sort index for FeatureSetImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_UPSERT
```
protected static final int SORT_INDEX_UPSERT
```
    Sort index for FeatureUpsertImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_WHERE
```
protected static final int SORT_INDEX_WHERE
```
    Sort index for FeatureWhereImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_LET
```
protected static final int SORT_INDEX_LET
```
    Sort index for FeatureLetImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_GROUP_BY
```
protected static final int SORT_INDEX_GROUP_BY
```
    Sort index for FeatureGroupByImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_HAVING
```
protected static final int SORT_INDEX_HAVING
```
    Sort index for FeatureHavingImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_ORDER_BY
```
protected static final int SORT_INDEX_ORDER_BY
```
    Sort index for FeatureOrderByImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_UNWIND
```
protected static final int SORT_INDEX_UNWIND
```
    Sort index for FeatureUnwindImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_PAGING
```
protected static final int SORT_INDEX_PAGING
```
    Sort index for FeaturePagingImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_FETCHPLAN
```
protected static final int SORT_INDEX_FETCHPLAN
```
    Sort index for FeatureFetchplanImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_TIMEOUT
```
protected static final int SORT_INDEX_TIMEOUT
```
    Sort index for FeatureTimeoutImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_LOCK
```
protected static final int SORT_INDEX_LOCK
```
    Sort index for FeatureLockImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_PARALLEL
```
protected static final int SORT_INDEX_PARALLEL
```
    Sort index for FeatureParallelImpl.
    
    See Also:
    
    Constant Field Values
  - SORT_INDEX_NOCACHE
```
protected static final int SORT_INDEX_NOCACHE
```
    Sort index for FeatureNoCacheImpl.
    
    See Also:
    
    Constant Field Values
  - sortIndex
```
private final int sortIndex
```
  - statement
```
private AbstractStatement<?,?> statement
```
- Constructor Detail
  - AbstractFeature
```
public AbstractFeature(int sortIndex)
```
    The constructor.
    
    Parameters:
    
    sortIndex - the sort index.
- Method Detail
  - getSortIndex
```
public int getSortIndex()
```
    Returns:
    
    the sort index used to define the order of the SQL fragments when building a statement from multiple features.
  - getStatement
```
public AbstractStatement<?,?> getStatement()
```
    Returns:
    
    the Statement.
  - getDialect
```
protected SqlDialect getDialect()
```
    Returns:
    
    the SqlDialect.
  - setStatement
```
public void setStatement(AbstractStatement<?,?> statement)
```
    Parameters:
    
    statement - is the Statement to set.
  - asArg
```
protected <V> Argument<V> asArg(PropertyPath<V> path)
```
    Type Parameters:
    
    V - the generic type of the property value identified by path.
    
    Parameters:
    
    path - the PropertyPath.
    
    Returns:
    
    the given path as Argument.
  - asPath
```
protected <V> Path<V> asPath(PropertyPath<V> path)
```
    Type Parameters:
    
    V - the generic type of the property value identified by path.
    
    Parameters:
    
    path - the PropertyPath.
    
    Returns:
    
    the given path as Argument.
  - build
```
public abstract void build(SqlBuilder builder)
```
    Parameters:
    
    builder - the SqlBuilder with the query context to build the SQL and bind variables.
  - combine
```
protected Expression combine(Expression expression,
                             Conjunction conjunction,
                             Expression... newExpressions)
```
    Combines the given Expression with the given array of new Expressions using the given Conjunction.
    
    Parameters:
    
    expression - the current Expression or null.
    
    conjunction - the Conjunction used to combine.
    
    newExpressions - the array with the new Expressions to combine.
    
    Returns:
    
    the combined Expression.
  - compareTo
```
public int compareTo(AbstractFeature o)
```
    Specified by:
    
    compareTo in interface Comparable<AbstractFeature>
  - create
```
public static <F extends AbstractFeature> F create(Class<F> featureClass)
```
    Type Parameters:
    
    F - the generic type of the feature.
    
    Parameters:
    
    featureClass - the Class reflecting the feature.
    
    Returns:
    
    the new instance of the requested feature.

Class AbstractFeature

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SORT_INDEX_AND_FROM

SORT_INDEX_SET

SORT_INDEX_UPSERT

SORT_INDEX_WHERE

SORT_INDEX_LET

SORT_INDEX_GROUP_BY

SORT_INDEX_HAVING

SORT_INDEX_ORDER_BY

SORT_INDEX_UNWIND

SORT_INDEX_PAGING

SORT_INDEX_FETCHPLAN

SORT_INDEX_TIMEOUT

SORT_INDEX_LOCK

SORT_INDEX_PARALLEL

SORT_INDEX_NOCACHE

sortIndex

statement

Constructor Detail

AbstractFeature

Method Detail

getSortIndex

getStatement

getDialect

setStatement

asArg

asPath

build

combine

compareTo

create