WrapperMetaRawValueVO (Denodo ITPilot Client 7.0.14 API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

HTMLWrapperMetaRawValueVO

All Known Implementing Classes:

HTMLWrapperMetaArrayRawVO, HTMLWrapperMetaRegisterRawVO, HTMLWrapperMetaSimpleRawVO, WrapperMetaArrayRawVO, WrapperMetaRegisterRawVO, WrapperMetaSimpleRawVO
```
public interface WrapperMetaRawValueVO
extends Serializable
```
Interface which must be implemented by all the metatadata type fields of a Wrapper object.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ARRAY` Constant which identifies a `WrapperMetaArrayRawVO`.
`static int`	`ASC_AND_DESC_SORT` Constant indicating that a raw value is sortable in ascending and descending order.
`static int`	`ASCENDING_SORT` Constant indicating that a raw value is sortable in ascending order.
`static int`	`DESCENDING_SORT` Constant indicating that a raw value is sortable in descending order.
`static int`	`NOT_SORTABLE` Constant indicating that a raw value is not sortable.
`static int`	`REGISTER` Constant which identifies a `WrapperMetaRegisterRawVO`.
`static int`	`SIMPLE` Constant which identifies a `WrapperMetaSimpleRawVO`.

Method Summary

All Methods Instance Methods Abstract 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`	`getMapping()` Getter for WrapperMetaRawValue name mapping property.
`Integer`	`getMaxLength()` Gets the maximum length value for the field.
`String`	`getName()` Getter for WrapperMetaRawValueVO name property.
`Integer`	`getParameterIndex()` Gets the parameter index of a field.
`HashMap<String,String>`	`getPropertiesMap()`
`int`	`getRawType()` Return the int RawType of WrapperMetaRawValueVO WrapperMetaRawValueVO.SIMPLE for WrapperMetaSimpleRawVO WrapperMetaRawValueVO.ARRAY for WrapperMetaArrayRawVO WrapperMetaRawValueVO.REGISTER for WrapperMetaRegisterRawVO
`Integer`	`getResultSetIndex()`
`int`	`getSortable()` Obtains the property indicating the type of ordering which supports this raw value.
`boolean`	`isAutoIncrement()`
`boolean`	`isEscape()` Obtains the 'escape' property, which indicates that this value must be escaped when delegate it to the source
`boolean`	`isGeneratedColumn()`
`boolean`	`isMandatoryStatus()` Getter for mandatoryStatus attribute.
`boolean`	`isNullable()` Determines if this raw value can be null or not.
`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.
`void`	`setAutoIncrement(boolean autoIncrement)`
`void`	`setEscape(boolean escape)` Sets the 'escape' property, which indicates that this value must be escaped when delegate it to the source
`void`	`setGeneratedColumn(boolean generatedColumn)`
`void`	`setMandatoryStatus(boolean mandatoryStatus)` Setter for mandatoryStatus attribute.
`void`	`setMapping(String mapping)` Setter for WrapperMetaRawValue name mapping property.
`void`	`setMaxLength(Integer maxLength)` Sets the maximum length value for the field.
`void`	`setName(String name)` Setter for WrapperMetaRawValue name property.
`void`	`setNullable(boolean nullable)` Establishes if this raw value can be null or not.
`void`	`setParameterIndex(Integer parameterIndex)` Sets the parameter index of a field.
`void`	`setPropertiesMap(HashMap<String,String> propertiesMap)`
`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`	`setUpdateable(boolean updateable)` Establishes if this raw value can be updated or not.
`String`	`toString()` Obtains a String representation of the value.

- Field Detail
  - SIMPLE
```
static final int SIMPLE
```
    Constant which identifies a WrapperMetaSimpleRawVO.
    
    See Also:
    
    Constant Field Values
  - ARRAY
```
static final int ARRAY
```
    Constant which identifies a WrapperMetaArrayRawVO.
    
    See Also:
    
    Constant Field Values
  - REGISTER
```
static final int REGISTER
```
    Constant which identifies a WrapperMetaRegisterRawVO.
    
    See Also:
    
    Constant Field Values
  - NOT_SORTABLE
```
static final int NOT_SORTABLE
```
    Constant indicating that a raw value is not sortable.
    
    Since:
    
    3.5
    
    See Also:
    
    Constant Field Values
  - ASCENDING_SORT
```
static final int ASCENDING_SORT
```
    Constant indicating that a raw value is sortable in ascending order.
    
    Since:
    
    3.5
    
    See Also:
    
    Constant Field Values
  - DESCENDING_SORT
```
static final int DESCENDING_SORT
```
    Constant indicating that a raw value is sortable in descending order.
    
    Since:
    
    3.5
    
    See Also:
    
    Constant Field Values
  - ASC_AND_DESC_SORT
```
static final int ASC_AND_DESC_SORT
```
    Constant indicating that a raw value is sortable in ascending and descending order.
    
    Since:
    
    3.5
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
    Getter for WrapperMetaRawValueVO name property.
    
    Returns:
    
    the WrapperMetaRawValue instance name.
  - setName
```
void setName(String name)
```
    Setter for WrapperMetaRawValue name property.
    
    Parameters:
    
    name - the name of WrapperMetaRawValue instance
  - getMapping
```
String getMapping()
```
    Getter for WrapperMetaRawValue name mapping property.
    
    Returns:
    
    the WrapperMetaRawValue instance name mapping.
  - setMapping
```
void setMapping(String mapping)
```
    Setter for WrapperMetaRawValue name mapping property.
    
    Parameters:
    
    mapping - the mapping name of WrapperMetaRawValue instance
  - isNullable
```
boolean isNullable()
```
    Determines if this raw value can be null or not.
    
    Returns:
    
    tue if the raw value can be null, false otherwise.
    
    Since:
    
    3.5
  - setNullable
```
void setNullable(boolean nullable)
```
    Establishes if this raw value can be null or not.
    
    Parameters:
    
    nullable - if true, the raw value can be null.
    
    Since:
    
    3.5
  - getSortable
```
int getSortable()
```
    Obtains the property indicating the type of ordering which supports this raw value.
    
    Returns:
    
    the property indicating the type of ordering which supports this raw value.
    
    Since:
    
    3.5
  - setSortable
```
void setSortable(int sortable)
```
    Establishes the property indicating the type of ordering which supports this raw value.
    
    Parameters:
    
    sortable - the property indicating the type of ordering which supports this raw value.
    
    Since:
    
    3.5
  - isUpdateable
```
boolean isUpdateable()
```
    Determines if this raw value can be updated or not.
    
    Returns:
    
    tue if the raw value can be updated, false otherwise.
    
    Since:
    
    3.5
  - setUpdateable
```
void setUpdateable(boolean updateable)
```
    Establishes if this raw value can be updated or not.
    
    Parameters:
    
    updateable - if true, the raw value can be updated.
    
    Since:
    
    3.5
  - toString
```
String toString()
```
    Obtains a String representation of the value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String representation of the value.
  - getRawType
```
int getRawType()
```
    Return the int RawType of WrapperMetaRawValueVO WrapperMetaRawValueVO.SIMPLE for WrapperMetaSimpleRawVO WrapperMetaRawValueVO.ARRAY for WrapperMetaArrayRawVO WrapperMetaRawValueVO.REGISTER for WrapperMetaRegisterRawVO
    
    Returns:
    
    the int RawType of WrapperMetaRawValueVO
  - accept
```
void accept(com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper.visitor.WrapperMetaRawValueVisitor visitor)
```
    Accepts a WrapperMetaRawValueVisitor object that will process the WrapperMetaRawValueVO instance.
    
    Parameters:
    
    visitor - the visitor instance.
  - copy
```
Object copy()
```
    Obtains a copy of this object.
    
    Returns:
    
    a copy of this object.
  - isSearchStatus
```
boolean isSearchStatus()
```
    Getter for searchStatus attribute.
    
    Returns:
    
    true when this metadata field is searchable.
  - setSearchStatus
```
void setSearchStatus(boolean searchStatus)
```
    Setter for searchStatus attribute.
    
    Parameters:
    
    searchStatus -
  - isMandatoryStatus
```
boolean isMandatoryStatus()
```
    Getter for mandatoryStatus attribute.
    
    Returns:
    
    true when this metadata field is searchable.
  - setMandatoryStatus
```
void setMandatoryStatus(boolean mandatoryStatus)
```
    Setter for mandatoryStatus attribute.
    
    Parameters:
    
    mandatoryStatus -
  - isEscape
```
boolean isEscape()
```
    Obtains the 'escape' property, which indicates that this value must be escaped when delegate it to the source
    
    Returns:
    
    true if this is an escape property.
    
    Since:
    
    4.5
  - setEscape
```
void setEscape(boolean escape)
```
    Sets the 'escape' property, which indicates that this value must be escaped when delegate it to the source
    
    Parameters:
    
    escape - true if this is an escape property.
    
    Since:
    
    4.5
  - isSqlFragment
```
boolean isSqlFragment()
```
    Obtains the 'sqlFragment' property, which indicates that this value is a SQL fragment. Only apply for EXTERN fields.
    
    Returns:
    
    true if this is an sqlFragment property.
    
    Since:
    
    4.7
  - setSqlFragment
```
void setSqlFragment(boolean sqlFragment)
```
    Sets the 'sqlFragment' property, which indicates that this value is a SQL fragment. Only apply for EXTERN fields.
    
    Parameters:
    
    sqlFragment - true if this is an sqlFragment property.
    
    Since:
    
    4.7
  - getPropertiesMap
```
HashMap<String,String> getPropertiesMap()
```
  - setPropertiesMap
```
void setPropertiesMap(HashMap<String,String> propertiesMap)
```
    Parameters:
    
    propertiesMap - the propertiesMap to set
  - getMaxLength
```
Integer getMaxLength()
```
    Gets the maximum length value for the field.
    
    Returns:
    
    max length value.
  - setMaxLength
```
void setMaxLength(Integer maxLength)
```
    Sets the maximum length value for the field.
    
    Parameters:
    
    maxLength - max length value.
  - getParameterIndex
```
Integer getParameterIndex()
```
    Gets the parameter index of a field.
    
    Returns:
    
    parameter index
  - setParameterIndex
```
void setParameterIndex(Integer parameterIndex)
```
    Sets the parameter index of a field.
    
    Parameters:
    
    parameterIndex -
  - setResultSetIndex
```
void setResultSetIndex(Integer resultSetIndex)
```
    Set the index of the returned resultset this field belongs to
    
    Parameters:
    
    resultSetIndex -
  - getResultSetIndex
```
Integer getResultSetIndex()
```
    Returns:
    
    The index of the returned resultset this field belongs to
  - isAutoIncrement
```
boolean isAutoIncrement()
```
    Returns:
    
    the autoIncrement
  - setAutoIncrement
```
void setAutoIncrement(boolean autoIncrement)
```
    Parameters:
    
    autoIncrement - the autoIncrement to set
  - isGeneratedColumn
```
boolean isGeneratedColumn()
```
    Returns:
    
    the generatedColumns
  - setGeneratedColumn
```
void setGeneratedColumn(boolean generatedColumn)
```
    Parameters:
    
    generatedColumn - the generatedColumn to set

Interface WrapperMetaRawValueVO

Field Summary

Method Summary

Field Detail

SIMPLE

ARRAY

REGISTER

NOT_SORTABLE

ASCENDING_SORT

DESCENDING_SORT

ASC_AND_DESC_SORT

Method Detail

getName

setName

getMapping

setMapping

isNullable

setNullable

getSortable

setSortable

isUpdateable

setUpdateable

toString

getRawType

accept

copy

isSearchStatus

setSearchStatus

isMandatoryStatus

setMandatoryStatus

isEscape

setEscape

isSqlFragment

setSqlFragment

getPropertiesMap

setPropertiesMap

getMaxLength

setMaxLength

getParameterIndex

setParameterIndex

setResultSetIndex

getResultSetIndex

isAutoIncrement

setAutoIncrement

isGeneratedColumn

setGeneratedColumn