Module org.tentackle.model

Package org.tentackle.model.impl

Class EntityOptionsImpl

java.lang.Object

org.tentackle.model.impl.CommonOptionsImpl

org.tentackle.model.impl.EntityOptionsImpl

All Implemented Interfaces:

Cloneable, CommonOptions, EntityOptions

public class EntityOptionsImpl
extends CommonOptionsImpl
implements EntityOptions

Entity options.

Author:

harald

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPTION_CACHED	entity provides a cache.
static final String	OPTION_NO_MODELDEFAULTS	don't apply model defaults.
static final String	OPTION_NO_PRIMARY	don't generate ID as primary key.
static final String	OPTION_NORMTEXT	normText is provided.
static final String	OPTION_PROVIDED	entity provided by externally.
static final String	OPTION_REMOTE	enable remoting.
static final String	OPTION_ROOT	root entity.
static final String	OPTION_ROOTCLASSID	rootclassid is provided.
static final String	OPTION_ROOTID	rootid is provided.
static final String	OPTION_TABLESERIAL	column tableserial is provided.
static final String	OPTION_TOKENLOCK	token lock columns editedBy/Since/Expiry are provided.

Fields inherited from class org.tentackle.model.impl.CommonOptionsImpl

BIND_SIZE, OPTION_BIND, OPTION_MAPNULL, OPTION_MUTE, OPTION_NOCONSTANT, OPTION_NODECLARE, OPTION_NOMETHOD, OPTION_READONLY, OPTION_SUPER, OPTION_TRIM, OPTION_TRIM_READ, OPTION_TRIM_WRITE, OPTION_WRITEONLY

Constructor Summary

Constructors

Constructor	Description
EntityOptionsImpl(EntityFactory factory, Entity entity, SourceInfo sourceInfo)	Creates entity options.

Method Summary

Modifier and Type	Method	Description
boolean	applyOption(String option, Boolean ctrl)	Applies given option string.
protected EntityOptionsImpl	clone()	Clones the entity options. The method is protected, since clone(EntityImpl) should be used instead, which invokes clone().
EntityOptionsImpl	clone(EntityImpl entity)	Clones options for another entity instance.
Entity	getEntity()	Gets the entity this option-set belongs to.
List<String>	getSorting()	Gets the default sorting options.
TrackType	getTrackType()	Gets the tracking type.
boolean	isCached()	Returns whether the entity provides a cache. Only applicable to root entities.
boolean	isNoPrimaryKey()	true if [NOPKEY]-option set.
boolean	isNormTextProvided()	true if [NORMTEXT]-option set.
boolean	isProvided()	Returns whether the DDL of this entity is maintained by another application. Provided entities are ignored by the tentackle-sql maven plugin and no SQL-code will be generated at all, neither for create nor any migration.
boolean	isRemote()	Returns whether entity supports remoting.
boolean	isRoot()	true if [ROOT]-option set
boolean	isRootClassIdProvided()	true if [ROOTCLASSID]-option set.
boolean	isRootIdProvided()	true if [ROOTID]-option set.
boolean	isTableSerialProvided()	true if [TABLESERIAL]-option set.
boolean	isTokenLockProvided()	true if [TOKENLOCK]-option set.
boolean	noModelDefaults()	Returns whether global model defaults should be applied or not.
boolean	processSorting(String token)	Checks that the sorting string starts with a + or -.
void	setCached(boolean cached)
void	setNoModelDefaults(boolean noModelDefaults)
void	setNoPrimaryKey(boolean noPrimary)
void	setNormTextProvided(boolean normText)
void	setProvided(boolean provided)
void	setRemote(boolean remote)
void	setRootClassIdProvided(boolean rootClassId)
void	setRootEntity(boolean rootEntity)
void	setRootIdProvided(boolean rootId)
void	setTableSerialProvided(boolean tableSerial)
void	setTokenLockProvided(boolean tokenLockProvided)
void	setTrackType(TrackType trackType)

Methods inherited from class org.tentackle.model.impl.CommonOptionsImpl

addBindOption, createModelException, getAccessScope, getBindOptions, getComment, getSourceInfo, getStereotypes, isAutoSelect, isBindable, isFromSuper, isLowerCase, isMapNull, isMaxCol, isMute, isNoConstant, isNoDeclare, isNoMethod, isReadOnly, isTrimRead, isTrimWrite, isUpperCase, isWriteOnly, processBindOption, processOption, removeBindOption, setAccessScope, setAutoSelect, setBindable, setBindOptions, setComment, setFromSuper, setLowerCase, setMapNull, setMaxCol, setMute, setNoConstant, setNoDeclare, setNoMethod, setReadOnly, setStereotypes, setTrimRead, setTrimWrite, setUpperCase, setWriteOnly, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tentackle.model.CommonOptions

getAccessScope, getBindOptions, getComment, getStereotypes, isAutoSelect, isBindable, isFromSuper, isLowerCase, isMapNull, isMaxCol, isMute, isNoConstant, isNoDeclare, isNoMethod, isReadOnly, isTrimRead, isTrimWrite, isUpperCase, isWriteOnly, validate

Field Details

OPTION_NO_MODELDEFAULTS

public static final String OPTION_NO_MODELDEFAULTS

don't apply model defaults.

See Also:

• Constant Field Values

OPTION_NO_PRIMARY

public static final String OPTION_NO_PRIMARY

don't generate ID as primary key.

See Also:

• Constant Field Values

OPTION_TABLESERIAL

public static final String OPTION_TABLESERIAL

column tableserial is provided.

See Also:

• Constant Field Values

OPTION_TOKENLOCK

public static final String OPTION_TOKENLOCK

token lock columns editedBy/Since/Expiry are provided.

See Also:

• Constant Field Values

OPTION_NORMTEXT

public static final String OPTION_NORMTEXT

normText is provided.

See Also:

• Constant Field Values

OPTION_ROOT

public static final String OPTION_ROOT

root entity.

See Also:

• Constant Field Values

OPTION_ROOTID

public static final String OPTION_ROOTID

rootid is provided.

See Also:

• Constant Field Values

OPTION_ROOTCLASSID

public static final String OPTION_ROOTCLASSID

rootclassid is provided.

See Also:

• Constant Field Values

OPTION_REMOTE

public static final String OPTION_REMOTE

enable remoting.

See Also:

• Constant Field Values

OPTION_PROVIDED

public static final String OPTION_PROVIDED

entity provided by externally.

See Also:

• Constant Field Values

OPTION_CACHED

public static final String OPTION_CACHED

entity provides a cache.

See Also:

• Constant Field Values

Constructor Details

EntityOptionsImpl

public EntityOptionsImpl(EntityFactory factory,
 Entity entity,
 SourceInfo sourceInfo)

Creates entity options.

Parameters:

factory - the factory

entity - the entity the options belong to

sourceInfo - the source info

Method Details

clone

protected EntityOptionsImpl clone()

Clones the entity options.
The method is protected, since clone(EntityImpl) should be used instead, which invokes clone().

Overrides:

clone in class CommonOptionsImpl

Returns:

the cloned options

clone

public EntityOptionsImpl clone(EntityImpl entity)

Clones options for another entity instance.

Parameters:

entity - the entity

Returns:

the options

getEntity

public Entity getEntity()

Description copied from interface: EntityOptions

Gets the entity this option-set belongs to.

Specified by:

getEntity in interface EntityOptions

Returns:

the entity

noModelDefaults

public boolean noModelDefaults()

Description copied from interface: EntityOptions

Returns whether global model defaults should be applied or not.

Specified by:

noModelDefaults in interface EntityOptions

Returns:

true if ignore model defaults completely

applyOption

public boolean applyOption(String option,
 Boolean ctrl)
                    throws ModelException

Description copied from class: CommonOptionsImpl

Applies given option string.

Overrides:

applyOption in class CommonOptionsImpl

Parameters:

option - the option string

ctrl - option control: true if turn option on, false if option off, null if on/off missing (defaults to on)

Returns:

true if applied, false if unknown option

Throws:

ModelException - if applying the option failed

processSorting

public boolean processSorting(String token)

Checks that the sorting string starts with a + or -.

Parameters:

token - the sorting token

Returns:

true if applied

isNoPrimaryKey

public boolean isNoPrimaryKey()

Description copied from interface: EntityOptions

true if [NOPKEY]-option set.

Specified by:

isNoPrimaryKey in interface EntityOptions

Returns:

the NoPrimary

getTrackType

public TrackType getTrackType()

Description copied from interface: EntityOptions

Gets the tracking type.

Specified by:

getTrackType in interface EntityOptions

Returns:

the tracking type

isTableSerialProvided

public boolean isTableSerialProvided()

Description copied from interface: EntityOptions

true if [TABLESERIAL]-option set.

Specified by:

isTableSerialProvided in interface EntityOptions

Returns:

true if tableserial column provided

isTokenLockProvided

public boolean isTokenLockProvided()

Description copied from interface: EntityOptions

true if [TOKENLOCK]-option set.

Specified by:

isTokenLockProvided in interface EntityOptions

Returns:

true if token-lock columns provided

isNormTextProvided

public boolean isNormTextProvided()

Description copied from interface: EntityOptions

true if [NORMTEXT]-option set.

Specified by:

isNormTextProvided in interface EntityOptions

Returns:

true if normtext column provided

isRoot

public boolean isRoot()

Description copied from interface: EntityOptions

true if [ROOT]-option set

Specified by:

isRoot in interface EntityOptions

Returns:

true if this is a root entity

isRootIdProvided

public boolean isRootIdProvided()

Description copied from interface: EntityOptions

true if [ROOTID]-option set.

Specified by:

isRootIdProvided in interface EntityOptions

Returns:

true if rootid column provided

isRootClassIdProvided

public boolean isRootClassIdProvided()

Description copied from interface: EntityOptions

true if [ROOTCLASSID]-option set.

Specified by:

isRootClassIdProvided in interface EntityOptions

Returns:

true if rootclassid column provided

isRemote

public boolean isRemote()

Description copied from interface: EntityOptions

Returns whether entity supports remoting.

Specified by:

isRemote in interface EntityOptions

Returns:

true if with remoting, false if only local

isProvided

public boolean isProvided()

Description copied from interface: EntityOptions

Returns whether the DDL of this entity is maintained by another application.
Provided entities are ignored by the tentackle-sql maven plugin and no SQL-code will be generated at all, neither for create nor any migration.

Specified by:

isProvided in interface EntityOptions

Returns:

true if provided

isCached

public boolean isCached()

Description copied from interface: EntityOptions

Returns whether the entity provides a cache.
Only applicable to root entities.

Specified by:

isCached in interface EntityOptions

Returns:

true if cached

getSorting

public List<String> getSorting()

Description copied from interface: EntityOptions

Gets the default sorting options.

Specified by:

getSorting in interface EntityOptions

Returns:

the default sorting, null if none

setNoModelDefaults

public void setNoModelDefaults(boolean noModelDefaults)

setTrackType

public void setTrackType(TrackType trackType)

setTokenLockProvided

public void setTokenLockProvided(boolean tokenLockProvided)

setNormTextProvided

public void setNormTextProvided(boolean normText)

setNoPrimaryKey

public void setNoPrimaryKey(boolean noPrimary)

setTableSerialProvided

public void setTableSerialProvided(boolean tableSerial)

setRootEntity

public void setRootEntity(boolean rootEntity)

setRootIdProvided

public void setRootIdProvided(boolean rootId)

setRootClassIdProvided

public void setRootClassIdProvided(boolean rootClassId)

setRemote

public void setRemote(boolean remote)

setProvided

public void setProvided(boolean provided)

setCached

public void setCached(boolean cached)