CommonOptionsImpl (Tentackle Data Model 2.1.4 API)

java.lang.Object
- org.tentackle.model.impl.CommonOptionsImpl

All Implemented Interfaces:

CommonOptions

Direct Known Subclasses:

AttributeOptionsImpl, EntityOptionsImpl
```
public abstract class CommonOptionsImpl
extends Object
implements CommonOptions
```
Implementation of common options.

Author:

harald

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BIND_SIZE` set max columns and/or scale.
`static String`	`OPTION_BIND` add binding information.
`static String`	`OPTION_DERIVED` attribute is derived (table per class).
`static String`	`OPTION_MAPNULL` map null to non-null value.
`static String`	`OPTION_NOCONSTANT` don't generate static constants.
`static String`	`OPTION_NODECLARE` don't generate declaration.
`static String`	`OPTION_NOMETHOD` don't generate accessor methods.
`static String`	`OPTION_READONLY` don't generate a set-method.
`static String`	`OPTION_SETGET` always use set/get, don't use attributes directly in read/write.
`static String`	`OPTION_SUPER` attribute is derived (table per concrete class).
`static String`	`OPTION_TRIM` trim on read and write.
`static String`	`OPTION_TRIM_READ` trim string on read.
`static String`	`OPTION_TRIM_WRITE` trim string on write.
`static String`	`OPTION_WRITEONLY` don't generate a get-method.

Constructor Summary

Constructors
Constructor and Description

CommonOptionsImpl(SourceInfo sourceInfo)
Creates options.

Constructors
Constructor and Description
`CommonOptionsImpl(SourceInfo sourceInfo)` Creates options.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBindOption(String option)` Adds a bind option.
`boolean`	`applyOption(String option, Boolean ctrl)` Applies given option string.
`ModelException`	`createModelException(String message)`
`AccessScope`	`getAccessScope()` The access scope.
`String`	`getBindOptions()` The bind options.
`String`	`getComment()` The comment.
`SourceInfo`	`getSourceInfo()` Gets the source info.
`boolean`	`isAutoSelect()` Returns whether autoselect should be turned on.
`boolean`	`isBind()` true if [BIND]-option set.
`boolean`	`isDerived()` true if [DERIVED]-option set.
`boolean`	`isFromSuper()` true if [SUPER]-option set.
`boolean`	`isLowerCase()` Returns whether lowercase conversion requested.
`boolean`	`isMapNull()` true if [MAPNULL]-option set.
`boolean`	`isMaxCol()` Returns true whether the maxcol binding option should be applied.
`boolean`	`isNoConstant()` true if [NOCONSTANT]-option set.
`boolean`	`isNoDeclare()` true if [NODECLARE]-option set.
`boolean`	`isNoMethod()` true if [NOMETHOD]-option set.
`boolean`	`isReadOnly()` true if [READONLY]-option set.
`boolean`	`isSetGet()` true if [SETGET]-option set.
`boolean`	`isTrimRead()` true if [TRIMREAD]-option set.
`boolean`	`isTrimWrite()` true if [TRIMWRITE]-option set.
`boolean`	`isUpperCase()` Returns whether uppercase conversion requested.
`boolean`	`isWriteOnly()` true if [WRITEONLY]-option set.
`void`	`processBindOption(String option, boolean on)` Processes a bind option.
`boolean`	`processOption(String option)` Processes an option string. If the option string starts with ! or -, the option is considered to be turned off.
`void`	`removeBindOption(String option)` Removes a bind option.
`void`	`setAccessScope(AccessScope accessScope)`
`void`	`setAutoSelect(boolean autoSelect)`
`void`	`setBind(boolean bind)`
`void`	`setBindOptions(String bindOptions)`
`void`	`setComment(String comment)` Sets the comment.
`void`	`setDerived(boolean derived)`
`void`	`setFromSuper(boolean fromSuper)`
`void`	`setLowerCase(boolean lowerCase)`
`void`	`setMapNull(boolean mapNull)`
`void`	`setMaxCol(boolean maxCol)`
`void`	`setNoConstant(boolean noConstant)`
`void`	`setNoDeclare(boolean noDeclare)`
`void`	`setNoMethod(boolean noMethod)`
`void`	`setReadOnly(boolean readOnly)`
`void`	`setSetGet(boolean setGet)`
`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 String OPTION_NODECLARE
```
    don't generate declaration.
    
    See Also:
    
    Constant Field Values
  - OPTION_NOMETHOD
```
public static final String OPTION_NOMETHOD
```
    don't generate accessor methods.
    
    See Also:
    
    Constant Field Values
  - OPTION_NOCONSTANT
```
public static final String OPTION_NOCONSTANT
```
    don't generate static constants.
    
    See Also:
    
    Constant Field Values
  - OPTION_DERIVED
```
public static final String OPTION_DERIVED
```
    attribute is derived (table per class).
    
    See Also:
    
    Constant Field Values
  - OPTION_SUPER
```
public static final String OPTION_SUPER
```
    attribute is derived (table per concrete class).
    
    See Also:
    
    Constant Field Values
  - OPTION_READONLY
```
public static final String OPTION_READONLY
```
    don't generate a set-method.
    
    See Also:
    
    Constant Field Values
  - OPTION_WRITEONLY
```
public static final String OPTION_WRITEONLY
```
    don't generate a get-method.
    
    See Also:
    
    Constant Field Values
  - OPTION_TRIM_READ
```
public static final String OPTION_TRIM_READ
```
    trim string on read.
    
    See Also:
    
    Constant Field Values
  - OPTION_TRIM_WRITE
```
public static final String OPTION_TRIM_WRITE
```
    trim string on write.
    
    See Also:
    
    Constant Field Values
  - OPTION_TRIM
```
public static final String OPTION_TRIM
```
    trim on read and write.
    
    See Also:
    
    Constant Field Values
  - OPTION_MAPNULL
```
public static final String OPTION_MAPNULL
```
    map null to non-null value.
    
    See Also:
    
    Constant Field Values
  - OPTION_SETGET
```
public static final String OPTION_SETGET
```
    always use set/get, don't use attributes directly in read/write.
    
    See Also:
    
    Constant Field Values
  - OPTION_BIND
```
public static final String OPTION_BIND
```
    add binding information.
    
    See Also:
    
    Constant Field Values
  - BIND_SIZE
```
public static final 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(String option,
                           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(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(String option,
                              boolean on)
```
    Processes a bind option.
    
    Parameters:
    
    option - the bind option
    
    on - true if append, else remove
  - getComment
```
public String getComment()
```
    Description copied from interface: CommonOptions
    
    The comment.
    
    Specified by:
    
    getComment in interface CommonOptions
    
    Returns:
    
    the comment
  - setComment
```
public void setComment(String comment)
```
    Sets the comment.
    
    Parameters:
    
    comment - the comment
  - getBindOptions
```
public String getBindOptions()
```
    Description copied from interface: CommonOptions
    
    The bind options.
    
    Specified by:
    
    getBindOptions in interface CommonOptions
    
    Returns:
    
    the bind options
  - setBindOptions
```
public void setBindOptions(String bindOptions)
```
  - addBindOption
```
public void addBindOption(String option)
```
    Adds a bind option.
    
    Parameters:
    
    option - the option
  - removeBindOption
```
public void removeBindOption(String option)
```
    Removes a bind option.
    
    Parameters:
    
    option - the option
  - isNoDeclare
```
public boolean isNoDeclare()
```
    Description copied from interface: CommonOptions
    
    true if [NODECLARE]-option set.
    
    Specified by:
    
    isNoDeclare in interface CommonOptions
    
    Returns:
    
    the NoDeclare
  - isNoMethod
```
public boolean isNoMethod()
```
    Description copied from interface: CommonOptions
    
    true if [NOMETHOD]-option set.
    
    Specified by:
    
    isNoMethod in interface CommonOptions
    
    Returns:
    
    the NoMethod
  - isNoConstant
```
public boolean isNoConstant()
```
    Description copied from interface: CommonOptions
    
    true if [NOCONSTANT]-option set.
    
    Specified by:
    
    isNoConstant in interface CommonOptions
    
    Returns:
    
    the NoConstant
  - isDerived
```
public boolean isDerived()
```
    Description copied from interface: CommonOptions
    
    true if [DERIVED]-option set.
    
    Specified by:
    
    isDerived in interface CommonOptions
    
    Returns:
    
    the Derived
  - isFromSuper
```
public boolean isFromSuper()
```
    Description copied from interface: CommonOptions
    
    true if [SUPER]-option set.
    
    Specified by:
    
    isFromSuper in interface CommonOptions
    
    Returns:
    
    the FromSuper
  - isReadOnly
```
public boolean isReadOnly()
```
    Description copied from interface: CommonOptions
    
    true if [READONLY]-option set.
    
    Specified by:
    
    isReadOnly in interface CommonOptions
    
    Returns:
    
    the ReadOnly
  - isWriteOnly
```
public boolean isWriteOnly()
```
    Description copied from interface: CommonOptions
    
    true if [WRITEONLY]-option set.
    
    Specified by:
    
    isWriteOnly in interface CommonOptions
    
    Returns:
    
    the WriteOnly
  - getAccessScope
```
public AccessScope getAccessScope()
```
    Description copied from interface: CommonOptions
    
    The access scope.
    
    Specified by:
    
    getAccessScope in interface CommonOptions
    
    Returns:
    
    the AccessPackage
  - isTrimRead
```
public boolean isTrimRead()
```
    Description copied from interface: CommonOptions
    
    true if [TRIMREAD]-option set.
    
    Specified by:
    
    isTrimRead in interface CommonOptions
    
    Returns:
    
    the TrimRead
  - isTrimWrite
```
public boolean isTrimWrite()
```
    Description copied from interface: CommonOptions
    
    true if [TRIMWRITE]-option set.
    
    Specified by:
    
    isTrimWrite in interface CommonOptions
    
    Returns:
    
    the TrimWrite
  - isMapNull
```
public boolean isMapNull()
```
    Description copied from interface: CommonOptions
    
    true if [MAPNULL]-option set.
    
    Specified by:
    
    isMapNull in interface CommonOptions
    
    Returns:
    
    the MapNull
  - isSetGet
```
public boolean isSetGet()
```
    Description copied from interface: CommonOptions
    
    true if [SETGET]-option set.
    
    Specified by:
    
    isSetGet in interface CommonOptions
    
    Returns:
    
    the SetGet
  - isBind
```
public boolean isBind()
```
    Description copied from interface: CommonOptions
    
    true if [BIND]-option set.
    
    Specified by:
    
    isBind in interface CommonOptions
    
    Returns:
    
    the Bind
  - setAccessScope
```
public void setAccessScope(AccessScope accessScope)
```
  - setBind
```
public void setBind(boolean bind)
```
  - setDerived
```
public void setDerived(boolean derived)
```
  - 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)
```
  - setSetGet
```
public void setSetGet(boolean setGet)
```
  - 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(String message)
```

Class CommonOptionsImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPTION_NODECLARE

OPTION_NOMETHOD

OPTION_NOCONSTANT

OPTION_DERIVED

OPTION_SUPER

OPTION_READONLY

OPTION_WRITEONLY

OPTION_TRIM_READ

OPTION_TRIM_WRITE

OPTION_TRIM

OPTION_MAPNULL

OPTION_SETGET

OPTION_BIND

BIND_SIZE

Constructor Detail

CommonOptionsImpl

Method Detail

getSourceInfo

applyOption

processOption

processBindOption

getComment

setComment

getBindOptions

setBindOptions

addBindOption

removeBindOption

isNoDeclare

isNoMethod

isNoConstant

isDerived

isFromSuper

isReadOnly

isWriteOnly

getAccessScope

isTrimRead

isTrimWrite

isMapNull

isSetGet

isBind

setAccessScope

setBind

setDerived

setFromSuper

setMapNull

setNoConstant

setNoDeclare

setNoMethod

setReadOnly

setSetGet

setTrimRead

setTrimWrite

setWriteOnly

isAutoSelect

setAutoSelect

isLowerCase

setLowerCase

isMaxCol

setMaxCol

isUpperCase

setUpperCase

validate

createModelException