WrapperMetaSimpleRawVO (Denodo ITPilot Client 7.0.14 API)

java.lang.Object
- com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper.WrapperMetaSimpleRawVO

All Implemented Interfaces:

WrapperMetaRawValueVO, Serializable

Direct Known Subclasses:

HTMLWrapperMetaSimpleRawVO
```
public class WrapperMetaSimpleRawVO
extends Object
implements WrapperMetaRawValueVO
```
WrapperMetaRawValueVO implementation that encapsulates a simple metadata value represented with a name a and a Class type.

See Also:

Serialized Form

Field Summary
- Fields inherited from interface com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper.WrapperMetaRawValueVO
  ARRAY, ASC_AND_DESC_SORT, ASCENDING_SORT, DESCENDING_SORT, NOT_SORTABLE, REGISTER, SIMPLE

Constructor Summary

Constructors
Constructor and Description
`WrapperMetaSimpleRawVO()` Empty WrapperMetaSimpleRawVO constructor.
`WrapperMetaSimpleRawVO(String name, String mapping, boolean nullable, int sortable, boolean updateable, Class<?> type, boolean searchStatus, boolean mandatoryStatus, HashMap<String,String> propertiesMap, boolean extern, boolean escape)` WrapperMetaSimpleRawVO constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper.visitor.WrapperMetaRawValueVisitor visitor)` Accepts a `WrapperMetaRawValueVisitor` object that will process the WrapperMetaRawValueVO instance.
`Object`	`copy()` Obtains a copy of this object.
`String`	`getDefaultValue()`
`LinkedHashSet<String>`	`getFkNames()`
`LinkedHashSet<String>`	`getIndexesNames()`
`String`	`getMapping()` Getter for mapping attribute.
`Integer`	`getMaxLength()` Gets the maximum length value for the field.
`String`	`getName()` Getter for name attribute
`String`	`getNullValue()`
`Integer`	`getParameterIndex()` Gets the parameter index of a field.
`HashMap<String,String>`	`getPropertiesMap()`
`int`	`getRawType()` Returns The internal metadata type.
`String`	`getRemark()`
`Integer`	`getResultSetIndex()`
`int`	`getSortable()` Obtains the property indicating the type of ordering which supports this raw value.
`Class<?>`	`getType()` Getter for class type attribute.
`String`	`getTypeStringRepresentation()` Obtains a String representation of the type.
`boolean`	`isAutoIncrement()`
`boolean`	`isEscape()` Obtains the 'escape' property, which indicates that this value must be escaped when delegate it to the source
`boolean`	`isExtern()` Obtains the 'extern' property, which indicates that this value is not obtained from the source.
`boolean`	`isExternWhereExpression()`
`boolean`	`isGeneratedColumn()`
`boolean`	`isInForeignKey()`
`boolean`	`isInIndexes()`
`boolean`	`isMandatoryStatus()` Getter for mandatoryStatus attribute.
`boolean`	`isMeasure()` Gets the 'measure' property which indicates if the field is a measure of an olap wrapper.
`boolean`	`isNoAggregate()`
`boolean`	`isNullable()` Determines if this raw value can be null or not.
`boolean`	`isPrimaryKey()`
`boolean`	`isSearchStatus()` Getter for searchStatus attribute.
`boolean`	`isSqlFragment()` Obtains the 'sqlFragment' property, which indicates that this value is a SQL fragment.
`boolean`	`isUpdateable()` Determines if this raw value can be updated or not.
`boolean`	`isURIParam()`
`boolean`	`isVariable()` Used for sap-bw and olap wrappers.
`void`	`setAutoIncrement(boolean autoIncrement)`
`void`	`setDefaultValue(String defaultValue)`
`void`	`setEscape(boolean escape)` Sets the 'escape' property, which indicates that this value must be escaped when delegate it to the source
`void`	`setExtern(boolean extern)` Sets the 'extern' property, which indicates that this value is not obtained from the source.
`void`	`setExternWhereExpression(boolean externWhereExpression)`
`void`	`setFkNames(LinkedHashSet<String> fkNames)`
`void`	`setGeneratedColumn(boolean generatedColumn)`
`void`	`setIndexesNames(LinkedHashSet<String> indexesNames)`
`void`	`setMandatoryStatus(boolean mandatoryStatus)` Setter for mandatoryStatus attribute.
`void`	`setMapping(String mapping)` Setter for mapping attribute.
`void`	`setMaxLength(Integer maxLength)` Sets the maximum length value for the field.
`void`	`setMeasure(boolean measure)` Sets the 'measure' property which indicates if the field is a measure of an olap wrapper.
`void`	`setName(String name)` Setter for name attribute.
`void`	`setNoAggregate(boolean noAggregate)`
`void`	`setNullable(boolean nullable)` Establishes if this raw value can be null or not.
`void`	`setNullValue(String nullString)`
`void`	`setParameterIndex(Integer parameterIndex)` Sets the parameter index of a field.
`void`	`setPrimaryKey(boolean isPrimaryKey)`
`void`	`setPropertiesMap(HashMap<String,String> propertiesMap)`
`void`	`setRemark(String remark)`
`void`	`setResultSetIndex(Integer resultSetIndex)` Set the index of the returned resultset this field belongs to
`void`	`setSearchStatus(boolean searchStatus)` Setter for searchStatus attribute.
`void`	`setSortable(int sortable)` Establishes the property indicating the type of ordering which supports this raw value.
`void`	`setSqlFragment(boolean sqlFragment)` Sets the 'sqlFragment' property, which indicates that this value is a SQL fragment.
`void`	`setType(Class<?> type)` Setter for class type attribute.
`void`	`setUpdateable(boolean updateable)` Establishes if this raw value can be updated or not.
`void`	`setURIParam(boolean uriParam)`
`void`	`setVariable(boolean variable)` Used for sap-bw and olap wrappers.
`String`	`toString()` Obtains a String representation of the value.

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

- Constructor Detail
  - WrapperMetaSimpleRawVO
```
public WrapperMetaSimpleRawVO()
```
    Empty WrapperMetaSimpleRawVO constructor.
  - WrapperMetaSimpleRawVO
```
public WrapperMetaSimpleRawVO(String name,
                              String mapping,
                              boolean nullable,
                              int sortable,
                              boolean updateable,
                              Class<?> type,
                              boolean searchStatus,
                              boolean mandatoryStatus,
                              HashMap<String,String> propertiesMap,
                              boolean extern,
                              boolean escape)
```
    WrapperMetaSimpleRawVO constructor.
    
    Parameters:
    
    name - The name of the WrapperMetaSimpleRawVO object.
    
    mapping - The mapping of the WrapperMetaSimpleRawVO object.
    
    mandatoryStatus - true when this is a searchable mandatory field
    
    nullable - true when NULL value is allowed for this field
    
    sortable - the type of ordering for this field.
    
    updateable - true when this is an updateable field.
    
    type - the type of the field
    
    searchStatus - true when this is a searchable field
    
    extern - indicates if this value is obtained from the source or not.
    
    escape - indicates if this value must be escaped to delegate it.
- Method Detail
  - getDefaultValue
```
public String getDefaultValue()
```
    Returns:
    
    the defaultValue
  - setDefaultValue
```
public void setDefaultValue(String defaultValue)
```
    Parameters:
    
    defaultValue - the defaultValue to set
  - getRawType
```
public int getRawType()
```
    Returns The internal metadata type.
    
    Specified by:
    
    getRawType in interface WrapperMetaRawValueVO
    
    Returns:
    
    int code.
  - getType
```
public Class<?> getType()
```
    Getter for class type attribute.
    
    Returns:
    
    The Java class encapsulated under the String value.
  - setType
```
public void setType(Class<?> type)
```
    Setter for class type attribute.
    
    Parameters:
    
    type - The internal value Java class.
  - getName
```
public String getName()
```
    Getter for name attribute
    
    Specified by:
    
    getName in interface WrapperMetaRawValueVO
    
    Returns:
    
    the metadata name
  - setName
```
public void setName(String name)
```
    Setter for name attribute.
    
    Specified by:
    
    setName in interface WrapperMetaRawValueVO
    
    Parameters:
    
    name - The new metadata name.
  - getMapping
```
public String getMapping()
```
    Getter for mapping attribute.
    
    Specified by:
    
    getMapping in interface WrapperMetaRawValueVO
    
    Returns:
    
    Returns the mapping.
  - setMapping
```
public void setMapping(String mapping)
```
    Setter for mapping attribute.
    
    Specified by:
    
    setMapping in interface WrapperMetaRawValueVO
    
    Parameters:
    
    mapping - The mapping to set.
  - getPropertiesMap
```
public HashMap<String,String> getPropertiesMap()
```
    Specified by:
    
    getPropertiesMap in interface WrapperMetaRawValueVO
    
    Returns:
    
    the propertiesMap
  - setPropertiesMap
```
public void setPropertiesMap(HashMap<String,String> propertiesMap)
```
    Specified by:
    
    setPropertiesMap in interface WrapperMetaRawValueVO
    
    Parameters:
    
    propertiesMap - the propertiesMap to set
  - isNullable
```
public boolean isNullable()
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Determines if this raw value can be null or not.
    
    Specified by:
    
    isNullable in interface WrapperMetaRawValueVO
    
    Returns:
    
    tue if the raw value can be null, false otherwise.
    
    See Also:
    
    WrapperMetaRawValueVO.isNullable()
  - setNullable
```
public void setNullable(boolean nullable)
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Establishes if this raw value can be null or not.
    
    Specified by:
    
    setNullable in interface WrapperMetaRawValueVO
    
    Parameters:
    
    nullable - if true, the raw value can be null.
    
    See Also:
    
    WrapperMetaRawValueVO.setNullable(boolean)
  - getSortable
```
public int getSortable()
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Obtains the property indicating the type of ordering which supports this raw value.
    
    Specified by:
    
    getSortable in interface WrapperMetaRawValueVO
    
    Returns:
    
    the property indicating the type of ordering which supports this raw value.
    
    See Also:
    
    WrapperMetaRawValueVO.getSortable()
  - setSortable
```
public void setSortable(int sortable)
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Establishes the property indicating the type of ordering which supports this raw value.
    
    Specified by:
    
    setSortable in interface WrapperMetaRawValueVO
    
    Parameters:
    
    sortable - the property indicating the type of ordering which supports this raw value.
    
    See Also:
    
    WrapperMetaRawValueVO.setSortable(int)
  - isUpdateable
```
public boolean isUpdateable()
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Determines if this raw value can be updated or not.
    
    Specified by:
    
    isUpdateable in interface WrapperMetaRawValueVO
    
    Returns:
    
    tue if the raw value can be updated, false otherwise.
    
    See Also:
    
    WrapperMetaRawValueVO.isUpdateable()
  - setUpdateable
```
public void setUpdateable(boolean updateable)
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Establishes if this raw value can be updated or not.
    
    Specified by:
    
    setUpdateable in interface WrapperMetaRawValueVO
    
    Parameters:
    
    updateable - if true, the raw value can be updated.
    
    See Also:
    
    WrapperMetaRawValueVO.setUpdateable(boolean)
  - isSearchStatus
```
public boolean isSearchStatus()
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Getter for searchStatus attribute.
    
    Specified by:
    
    isSearchStatus in interface WrapperMetaRawValueVO
    
    Returns:
    
    true when this metadata field is searchable.
    
    See Also:
    
    WrapperMetaRawValueVO.isSearchStatus()
  - setSearchStatus
```
public void setSearchStatus(boolean searchStatus)
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Setter for searchStatus attribute.
    
    Specified by:
    
    setSearchStatus in interface WrapperMetaRawValueVO
    
    See Also:
    
    WrapperMetaRawValueVO.setSearchStatus(boolean)
  - isMandatoryStatus
```
public boolean isMandatoryStatus()
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Getter for mandatoryStatus attribute.
    
    Specified by:
    
    isMandatoryStatus in interface WrapperMetaRawValueVO
    
    Returns:
    
    true when this metadata field is searchable.
    
    See Also:
    
    WrapperMetaRawValueVO.isMandatoryStatus()
  - setMandatoryStatus
```
public void setMandatoryStatus(boolean mandatoryStatus)
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Setter for mandatoryStatus attribute.
    
    Specified by:
    
    setMandatoryStatus in interface WrapperMetaRawValueVO
    
    See Also:
    
    WrapperMetaRawValueVO.setMandatoryStatus(boolean)
  - getTypeStringRepresentation
```
public String getTypeStringRepresentation()
```
    Obtains a String representation of the type.
    
    Returns:
    
    a String representation of the type.
  - isExtern
```
public boolean isExtern()
```
    Obtains the 'extern' property, which indicates that this value is not obtained from the source.
    
    Returns:
    
    true if this is an extern property.
    
    Since:
    
    3.5
  - setExtern
```
public void setExtern(boolean extern)
```
    Sets the 'extern' property, which indicates that this value is not obtained from the source.
    
    Parameters:
    
    extern - true if this is an extern property.
    
    Since:
    
    3.5
  - isEscape
```
public boolean isEscape()
```
    Obtains the 'escape' property, which indicates that this value must be escaped when delegate it to the source
    
    Specified by:
    
    isEscape in interface WrapperMetaRawValueVO
    
    Returns:
    
    true if this is an escape property.
    
    Since:
    
    4.5
  - setEscape
```
public void setEscape(boolean escape)
```
    Sets the 'escape' property, which indicates that this value must be escaped when delegate it to the source
    
    Specified by:
    
    setEscape in interface WrapperMetaRawValueVO
    
    Parameters:
    
    escape - true if this is an escape property.
    
    Since:
    
    4.5
  - isMeasure
```
public boolean isMeasure()
```
    Gets the 'measure' property which indicates if the field is a measure of an olap wrapper.
    
    Returns:
    
    measure
    
    Since:
    
    4.7
  - setMeasure
```
public void setMeasure(boolean measure)
```
    Sets the 'measure' property which indicates if the field is a measure of an olap wrapper.
    
    Parameters:
    
    measure -
    
    Since:
    
    4.7
  - getParameterIndex
```
public Integer getParameterIndex()
```
    Gets the parameter index of a field.
    
    Specified by:
    
    getParameterIndex in interface WrapperMetaRawValueVO
    
    Returns:
    
    parameter index
  - setParameterIndex
```
public void setParameterIndex(Integer parameterIndex)
```
    Sets the parameter index of a field.
    
    Specified by:
    
    setParameterIndex in interface WrapperMetaRawValueVO
    
    Parameters:
    
    parameterIndex -
  - isVariable
```
public boolean isVariable()
```
    Used for sap-bw and olap wrappers.
    
    Returns:
    
    the variable
    
    Since:
    
    4.7
  - setVariable
```
public void setVariable(boolean variable)
```
    Used for sap-bw and olap wrappers.
    
    Parameters:
    
    variable - the variable to set
    
    Since:
    
    4.7
  - isSqlFragment
```
public boolean isSqlFragment()
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Obtains the 'sqlFragment' property, which indicates that this value is a SQL fragment. Only apply for EXTERN fields.
    
    Specified by:
    
    isSqlFragment in interface WrapperMetaRawValueVO
    
    Returns:
    
    true if this is an sqlFragment property.
  - setSqlFragment
```
public void setSqlFragment(boolean sqlFragment)
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Sets the 'sqlFragment' property, which indicates that this value is a SQL fragment. Only apply for EXTERN fields.
    
    Specified by:
    
    setSqlFragment in interface WrapperMetaRawValueVO
    
    Parameters:
    
    sqlFragment - true if this is an sqlFragment property.
  - isURIParam
```
public boolean isURIParam()
```
  - setURIParam
```
public void setURIParam(boolean uriParam)
```
  - isExternWhereExpression
```
public boolean isExternWhereExpression()
```
  - setExternWhereExpression
```
public void setExternWhereExpression(boolean externWhereExpression)
```
  - getMaxLength
```
public Integer getMaxLength()
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Gets the maximum length value for the field.
    
    Specified by:
    
    getMaxLength in interface WrapperMetaRawValueVO
    
    Returns:
    
    max length value.
  - setMaxLength
```
public void setMaxLength(Integer maxLength)
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Sets the maximum length value for the field.
    
    Specified by:
    
    setMaxLength in interface WrapperMetaRawValueVO
    
    Parameters:
    
    maxLength - max length value.
  - getRemark
```
public String getRemark()
```
  - setRemark
```
public void setRemark(String remark)
```
  - isPrimaryKey
```
public boolean isPrimaryKey()
```
  - setPrimaryKey
```
public void setPrimaryKey(boolean isPrimaryKey)
```
  - isInForeignKey
```
public boolean isInForeignKey()
```
  - isInIndexes
```
public boolean isInIndexes()
```
  - getFkNames
```
public LinkedHashSet<String> getFkNames()
```
  - setFkNames
```
public void setFkNames(LinkedHashSet<String> fkNames)
```
  - getIndexesNames
```
public LinkedHashSet<String> getIndexesNames()
```
  - setIndexesNames
```
public void setIndexesNames(LinkedHashSet<String> indexesNames)
```
  - getNullValue
```
public String getNullValue()
```
  - setNullValue
```
public void setNullValue(String nullString)
```
  - setResultSetIndex
```
public void setResultSetIndex(Integer resultSetIndex)
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Set the index of the returned resultset this field belongs to
    
    Specified by:
    
    setResultSetIndex in interface WrapperMetaRawValueVO
  - getResultSetIndex
```
public Integer getResultSetIndex()
```
    Specified by:
    
    getResultSetIndex in interface WrapperMetaRawValueVO
    
    Returns:
    
    The index of the returned resultset this field belongs to
  - accept
```
public void accept(com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper.visitor.WrapperMetaRawValueVisitor visitor)
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Accepts a WrapperMetaRawValueVisitor object that will process the WrapperMetaRawValueVO instance.
    
    Specified by:
    
    accept in interface WrapperMetaRawValueVO
    
    Parameters:
    
    visitor - the visitor instance.
    
    See Also:
    
    WrapperMetaRawValueVO.accept(com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper.visitor.WrapperMetaRawValueVisitor)
  - toString
```
public String toString()
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Obtains a String representation of the value.
    
    Specified by:
    
    toString in interface WrapperMetaRawValueVO
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String representation of the value.
    
    See Also:
    
    WrapperMetaRawValueVO.toString()
  - copy
```
public Object copy()
```
    Description copied from interface: WrapperMetaRawValueVO
    
    Obtains a copy of this object.
    
    Specified by:
    
    copy in interface WrapperMetaRawValueVO
    
    Returns:
    
    a copy of this object.
    
    See Also:
    
    WrapperMetaRawValueVO.copy()
  - isAutoIncrement
```
public boolean isAutoIncrement()
```
    Specified by:
    
    isAutoIncrement in interface WrapperMetaRawValueVO
    
    Returns:
    
    the autoIncrement
  - setAutoIncrement
```
public void setAutoIncrement(boolean autoIncrement)
```
    Specified by:
    
    setAutoIncrement in interface WrapperMetaRawValueVO
    
    Parameters:
    
    autoIncrement - the autoIncrement to set
  - isGeneratedColumn
```
public boolean isGeneratedColumn()
```
    Specified by:
    
    isGeneratedColumn in interface WrapperMetaRawValueVO
    
    Returns:
    
    the generatedColumns
  - setGeneratedColumn
```
public void setGeneratedColumn(boolean generatedColumn)
```
    Specified by:
    
    setGeneratedColumn in interface WrapperMetaRawValueVO
    
    Parameters:
    
    generatedColumn - the generatedColumn to set
  - isNoAggregate
```
public boolean isNoAggregate()
```
  - setNoAggregate
```
public void setNoAggregate(boolean noAggregate)
```

Class WrapperMetaSimpleRawVO

Field Summary

Fields inherited from interface com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper.WrapperMetaRawValueVO

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WrapperMetaSimpleRawVO

WrapperMetaSimpleRawVO

Method Detail

getDefaultValue

setDefaultValue

getRawType

getType

setType

getName

setName

getMapping

setMapping

getPropertiesMap

setPropertiesMap

isNullable

setNullable

getSortable

setSortable

isUpdateable

setUpdateable

isSearchStatus

setSearchStatus

isMandatoryStatus

setMandatoryStatus

getTypeStringRepresentation

isExtern

setExtern

isEscape

setEscape

isMeasure

setMeasure

getParameterIndex

setParameterIndex

isVariable

setVariable

isSqlFragment

setSqlFragment

isURIParam

setURIParam

isExternWhereExpression

setExternWhereExpression

getMaxLength

setMaxLength

getRemark

setRemark

isPrimaryKey

setPrimaryKey

isInForeignKey

isInIndexes

getFkNames

setFkNames

getIndexesNames

setIndexesNames

getNullValue

setNullValue

setResultSetIndex

getResultSetIndex

accept

toString

copy

isAutoIncrement

setAutoIncrement

isGeneratedColumn

setGeneratedColumn

isNoAggregate

setNoAggregate