Module org.tentackle.model

Package org.tentackle.model.impl

Class CommonOptionsImpl

java.lang.Object

org.tentackle.model.impl.CommonOptionsImpl

All Implemented Interfaces:

CommonOptions

Direct Known Subclasses:

AttributeOptionsImpl, EntityOptionsImpl

public abstract class CommonOptionsImpl
extends java.lang.Object
implements CommonOptions

Implementation of common options.

Author:

harald

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BIND_SIZE	set max columns and/or scale.
static java.lang.String	OPTION_BIND	add binding information.
static java.lang.String	OPTION_MAPNULL	map null to non-null value.
static java.lang.String	OPTION_MUTE	element is mute (not part of PDO).
static java.lang.String	OPTION_NOCONSTANT	don't generate static constants.
static java.lang.String	OPTION_NODECLARE	don't generate declaration.
static java.lang.String	OPTION_NOMETHOD	don't generate accessor methods.
static java.lang.String	OPTION_READONLY	don't generate a set-method.
static java.lang.String	OPTION_SUPER	element is derived from superclass.
static java.lang.String	OPTION_TRIM	trim on read and write.
static java.lang.String	OPTION_TRIM_READ	trim string on read.
static java.lang.String	OPTION_TRIM_WRITE	trim string on write.
static java.lang.String	OPTION_WRITEONLY	don't generate a get-method.

Constructor Summary

Constructors

Constructor	Description
CommonOptionsImpl(SourceInfo sourceInfo)	Creates options.

Method Summary

Modifier and Type	Method	Description
void	addBindOption(java.lang.String option)	Adds a bind option.
boolean	applyOption(java.lang.String option, java.lang.Boolean ctrl)	Applies given option string.
ModelException	createModelException(java.lang.String message)
AccessScope	getAccessScope()	The access scope.
java.lang.String	getBindOptions()	The bind options.
java.lang.String	getComment()	The comment.
SourceInfo	getSourceInfo()	Gets the source info.
boolean	isAutoSelect()	Returns whether autoselect should be turned on.
boolean	isBindable()	Generate bindable annotation.
boolean	isFromSuper()	Declared in super class.
boolean	isLowerCase()	Returns whether lowercase conversion requested.
boolean	isMapNull()	Map null values to constant in database.
boolean	isMaxCol()	Returns true whether the maxcol binding option should be applied.
boolean	isMute()	Element is mute.
boolean	isNoConstant()	No constant strings.
boolean	isNoDeclare()	No declaration code.
boolean	isNoMethod()	No getter and setter methods.
boolean	isReadOnly()	Element is readonly.
boolean	isTrimRead()	Trim on read from database.
boolean	isTrimWrite()	Trim on write to database.
boolean	isUpperCase()	Returns whether uppercase conversion requested.
boolean	isWriteOnly()	Element is writeonly.
void	processBindOption(java.lang.String option, boolean on)	Processes a bind option.
boolean	processOption(java.lang.String option)	Processes an option string. If the option string starts with ! or -, the option is considered to be turned off.
void	removeBindOption(java.lang.String option)	Removes a bind option.
void	setAccessScope(AccessScope accessScope)
void	setAutoSelect(boolean autoSelect)
void	setBindable(boolean bind)
void	setBindOptions(java.lang.String bindOptions)
void	setComment(java.lang.String comment)	Sets the comment.
void	setFromSuper(boolean fromSuper)
void	setLowerCase(boolean lowerCase)
void	setMapNull(boolean mapNull)
void	setMaxCol(boolean maxCol)
void	setMute(boolean mute)
void	setNoConstant(boolean noConstant)
void	setNoDeclare(boolean noDeclare)
void	setNoMethod(boolean noMethod)
void	setReadOnly(boolean readOnly)
void	setTrimRead(boolean trimRead)
void	setTrimWrite(boolean trimWrite)
void	setUpperCase(boolean upperCase)
void	setWriteOnly(boolean writeOnly)
void	validate()	Validates the options.

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_NODECLARE

public static final java.lang.String OPTION_NODECLARE

don't generate declaration.

See Also:

Constant Field Values

OPTION_NOMETHOD

public static final java.lang.String OPTION_NOMETHOD

don't generate accessor methods.

See Also:

Constant Field Values

OPTION_NOCONSTANT

public static final java.lang.String OPTION_NOCONSTANT

don't generate static constants.

See Also:

Constant Field Values

OPTION_MUTE

public static final java.lang.String OPTION_MUTE

element is mute (not part of PDO).

See Also:

Constant Field Values

OPTION_SUPER

public static final java.lang.String OPTION_SUPER

element is derived from superclass.

See Also:

Constant Field Values

OPTION_READONLY

public static final java.lang.String OPTION_READONLY

don't generate a set-method.

See Also:

Constant Field Values

OPTION_WRITEONLY

public static final java.lang.String OPTION_WRITEONLY

don't generate a get-method.

See Also:

Constant Field Values

OPTION_TRIM_READ

public static final java.lang.String OPTION_TRIM_READ

trim string on read.

See Also:

Constant Field Values

OPTION_TRIM_WRITE

public static final java.lang.String OPTION_TRIM_WRITE

trim string on write.

See Also:

Constant Field Values

OPTION_TRIM

public static final java.lang.String OPTION_TRIM

trim on read and write.

See Also:

Constant Field Values

OPTION_MAPNULL

public static final java.lang.String OPTION_MAPNULL

map null to non-null value.

See Also:

Constant Field Values

OPTION_BIND

public static final java.lang.String OPTION_BIND

add binding information.

See Also:

Constant Field Values

BIND_SIZE

public static final java.lang.String BIND_SIZE

set max columns and/or scale.

See Also:

Constant Field Values

Constructor Detail

CommonOptionsImpl

public CommonOptionsImpl(SourceInfo sourceInfo)

Creates options.

Parameters:

sourceInfo - the source info, null if none

Method Detail

getSourceInfo

public SourceInfo getSourceInfo()

Gets the source info.

Returns:

the info, null if unknown

applyOption

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

Applies given option string.

Parameters:

option - the option string

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

Returns:

true if applied, false if unknown option

Throws:

ModelException - if applying the option failed

processOption

public boolean processOption(java.lang.String option)
                      throws ModelException

Processes an option string.
If the option string starts with ! or -, the option is considered to be turned off. If the option starts with '+' it is forced to be turned on. In all other cases it is left to the implementation of applyOption(java.lang.String, java.lang.Boolean) how the option should be treated.

Parameters:

option - the option string

Returns:

true if option applied, false if not known

Throws:

ModelException - if option malformed

processBindOption

public void processBindOption(java.lang.String option,
                              boolean on)

Processes a bind option.

Parameters:

option - the bind option

on - true if append, else remove

getComment

public java.lang.String getComment()

Description copied from interface: CommonOptions

The comment.

Specified by:

getComment in interface CommonOptions

Returns:

the comment

setComment

public void setComment(java.lang.String comment)

Sets the comment.

Parameters:

comment - the comment

getBindOptions

public java.lang.String getBindOptions()

Description copied from interface: CommonOptions

The bind options.

Specified by:

getBindOptions in interface CommonOptions

Returns:

the bind options

setBindOptions

public void setBindOptions(java.lang.String bindOptions)

addBindOption

public void addBindOption(java.lang.String option)

Adds a bind option.

Parameters:

option - the option

removeBindOption

public void removeBindOption(java.lang.String option)

Removes a bind option.

Parameters:

option - the option

isNoDeclare

public boolean isNoDeclare()

Description copied from interface: CommonOptions

No declaration code.

Specified by:

isNoDeclare in interface CommonOptions

Returns:

true if don't generate declaration

isNoMethod

public boolean isNoMethod()

Description copied from interface: CommonOptions

No getter and setter methods.

Specified by:

isNoMethod in interface CommonOptions

Returns:

true if don't generate accessor methods

isNoConstant

public boolean isNoConstant()

Description copied from interface: CommonOptions

No constant strings.

Specified by:

isNoConstant in interface CommonOptions

Returns:

true if don't generate constants for names

isMute

public boolean isMute()

Description copied from interface: CommonOptions

Element is mute.

Specified by:

isMute in interface CommonOptions

Returns:

true if not part of the pdo

isFromSuper

public boolean isFromSuper()

Description copied from interface: CommonOptions

Declared in super class.

Specified by:

isFromSuper in interface CommonOptions

Returns:

true if element is derived from the super class

isReadOnly

public boolean isReadOnly()

Description copied from interface: CommonOptions

Element is readonly.

Specified by:

isReadOnly in interface CommonOptions

Returns:

true if cannot be modified

isWriteOnly

public boolean isWriteOnly()

Description copied from interface: CommonOptions

Element is writeonly.

Specified by:

isWriteOnly in interface CommonOptions

Returns:

true if cannot be read by application

getAccessScope

public AccessScope getAccessScope()

Description copied from interface: CommonOptions

The access scope.

Specified by:

getAccessScope in interface CommonOptions

Returns:

the scope

isTrimRead

public boolean isTrimRead()

Description copied from interface: CommonOptions

Trim on read from database.

Specified by:

isTrimRead in interface CommonOptions

Returns:

true if string is trimmed when read

isTrimWrite

public boolean isTrimWrite()

Description copied from interface: CommonOptions

Trim on write to database.

Specified by:

isTrimWrite in interface CommonOptions

Returns:

true if string is trimmed on write

isMapNull

public boolean isMapNull()

Description copied from interface: CommonOptions

Map null values to constant in database.

Specified by:

isMapNull in interface CommonOptions

Returns:

true if map null to non-null value

isBindable

public boolean isBindable()

Description copied from interface: CommonOptions

Generate bindable annotation.

Specified by:

isBindable in interface CommonOptions

Returns:

true if bindable element

setAccessScope

public void setAccessScope(AccessScope accessScope)

setBindable

public void setBindable(boolean bind)

setMute

public void setMute(boolean mute)

setFromSuper

public void setFromSuper(boolean fromSuper)

setMapNull

public void setMapNull(boolean mapNull)

setNoConstant

public void setNoConstant(boolean noConstant)

setNoDeclare

public void setNoDeclare(boolean noDeclare)

setNoMethod

public void setNoMethod(boolean noMethod)

setReadOnly

public void setReadOnly(boolean readOnly)

setTrimRead

public void setTrimRead(boolean trimRead)

setTrimWrite

public void setTrimWrite(boolean trimWrite)

setWriteOnly

public void setWriteOnly(boolean writeOnly)

isAutoSelect

public boolean isAutoSelect()

Description copied from interface: CommonOptions

Returns whether autoselect should be turned on.

Specified by:

isAutoSelect in interface CommonOptions

Returns:

true if autoselect

setAutoSelect

public void setAutoSelect(boolean autoSelect)

isLowerCase

public boolean isLowerCase()

Description copied from interface: CommonOptions

Returns whether lowercase conversion requested.

Specified by:

isLowerCase in interface CommonOptions

Returns:

true if lowercase

setLowerCase

public void setLowerCase(boolean lowerCase)

isMaxCol

public boolean isMaxCol()

Description copied from interface: CommonOptions

Returns true whether the maxcol binding option should be applied.

Specified by:

isMaxCol in interface CommonOptions

Returns:

true if maxcol

setMaxCol

public void setMaxCol(boolean maxCol)

isUpperCase

public boolean isUpperCase()

Description copied from interface: CommonOptions

Returns whether uppercase conversion requested.

Specified by:

isUpperCase in interface CommonOptions

Returns:

true if uppercase

setUpperCase

public void setUpperCase(boolean upperCase)

validate

public void validate()
              throws ModelException

Description copied from interface: CommonOptions

Validates the options.

Specified by:

validate in interface CommonOptions

Throws:

ModelException - if validation failed

createModelException

public ModelException createModelException(java.lang.String message)