com.speedment.runtime.field

Interface Field<ENTITY>

Type Parameters:

ENTITY - the entity type

All Superinterfaces:

HasGetter<ENTITY>, HasIdentifier<ENTITY>, HasSetter<ENTITY>, HasTypeMapper

All Known Subinterfaces:

BooleanField<ENTITY,D>, ByteField<ENTITY,D>, ByteForeignKeyField<ENTITY,D,FK_ENTITY>, CharField<ENTITY,D>, CharForeignKeyField<ENTITY,D,FK_ENTITY>, ComparableField<ENTITY,D,V>, ComparableForeignKeyField<ENTITY,D,V,FK>, DoubleField<ENTITY,D>, DoubleForeignKeyField<ENTITY,D,FK_ENTITY>, EnumField<ENTITY,D,E>, EnumForeignKeyField<ENTITY,D,E,FK>, FloatField<ENTITY,D>, FloatForeignKeyField<ENTITY,D,FK_ENTITY>, HasBooleanOperators<ENTITY>, HasBooleanValue<ENTITY,D>, HasByteValue<ENTITY,D>, HasCharValue<ENTITY,D>, HasComparableOperators<ENTITY,V>, HasDoubleValue<ENTITY,D>, HasFinder<ENTITY,FK_ENTITY>, HasFloatValue<ENTITY,D>, HasIntValue<ENTITY,D>, HasLongValue<ENTITY,D>, HasNullableFinder<ENTITY,FK_ENTITY>, HasReferenceValue<ENTITY,D,V>, HasShortValue<ENTITY,D>, IntField<ENTITY,D>, IntForeignKeyField<ENTITY,D,FK_ENTITY>, LongField<ENTITY,D>, LongForeignKeyField<ENTITY,D,FK_ENTITY>, ReferenceField<ENTITY,D,V>, ShortField<ENTITY,D>, ShortForeignKeyField<ENTITY,D,FK_ENTITY>, StringField<ENTITY,D>, StringForeignKeyField<ENTITY,D,FK_ENTITY>

public interface Field<ENTITY>
extends HasIdentifier<ENTITY>, HasGetter<ENTITY>, HasSetter<ENTITY>, HasTypeMapper

The base interface for all fields.

Since:

2.2.0

Author:

Per Minborg, Emil Forslund

Method Summary

Modifier and Type	Method and Description
boolean	isUnique() Returns true if the column that this field represents is UNIQUE.
String	tableAlias() Returns the table alias for this field.
Field<ENTITY>	tableAlias(String tableAlias) Creates and returns a new Field with the provided tableAlias.

Methods inherited from interface com.speedment.runtime.field.trait.HasIdentifier

findColumn, identifier

Methods inherited from interface com.speedment.runtime.field.trait.HasGetter

getter

Methods inherited from interface com.speedment.runtime.field.trait.HasSetter

setter

Methods inherited from interface com.speedment.runtime.field.trait.HasTypeMapper

typeMapper

Method Detail

isUnique

boolean isUnique()

Returns true if the column that this field represents is UNIQUE.

Returns:

true if unique

tableAlias

String tableAlias()

Returns the table alias for this field. The default table alias is the table name for the field. A custom value can be set using the tableAlias(String) method.

Returns:

the table alias for this field

Since:

3.1.3

tableAlias

Field<ENTITY> tableAlias(String tableAlias)

Creates and returns a new Field with the provided tableAlias. The new Field will retain all other properties from this field except the tableAlias.

Parameters:

tableAlias - the table alias to use in the new field

Returns:

a new Field with the provided tableAlias

Throws:

NullPointerException - if the provided tableAlias is null

Since:

3.1.3