com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper

Class WrapperMetaArrayRawVO

java.lang.Object

com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper.WrapperMetaArrayRawVO

All Implemented Interfaces:

WrapperMetaRawValueVO, Serializable

Direct Known Subclasses:

HTMLWrapperMetaArrayRawVO

public class WrapperMetaArrayRawVO
extends Object
implements WrapperMetaRawValueVO

WrapperMetaRawValueVO implementation which encapsulates an array metadata value that contains a internal WrapperMetaRegisterRawVO.

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
WrapperMetaArrayRawVO() Empty WrapperMetaArrayRawVO constructor.
WrapperMetaArrayRawVO(String name, String mapping, boolean nullable, int sortable, boolean updateable) WrapperMetaArrayRawVO constructor.
WrapperMetaArrayRawVO(String name, WrapperMetaRegisterRawVO registerRaw, boolean mandatoryStatus, boolean nullable, int sortable, boolean updateable, boolean searchStatus) WrapperMetaArrayRawVO constructor.

Method Summary

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.
Boolean	getIsCursorField()
Boolean	getIsTableField()
String	getMapping() Getter method for mapping property.
Integer	getMaxLength() Gets the maximum length value for the field.
WrapperMetaRegisterRawVO	getMetaRegister() Getter method for the internal metadata register field
String	getName() Getter method for name attribute.
Integer	getParameterIndex() Gets the parameter index of a field.
HashMap<String,String>	getPropertiesMap()
int	getRawType() The int WrapperMetaArrayRawVO identifier.
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	isExtern() Obtains the 'extern' property, which indicates that this value is not obtained from 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.
WrapperMetaArrayRawVO	newInstance() Creates a new WrapperMetaArrayRawVO
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	setExtern(boolean extern) Sets the 'extern' property, which indicates that this value is not obtained from the source.
void	setGeneratedColumn(boolean generatedColumn)
void	setIsCursorField(Boolean isCursorField)
void	setIsTableField(Boolean isTableField)
void	setMandatoryStatus(boolean mandatoryStatus) Setter for mandatoryStatus attribute.
void	setMapping(String mapping) Setter method for mapping property.
void	setMaxLength(Integer length) Sets the maximum length value for the field.
void	setMetaRegister(WrapperMetaRegisterRawVO metaRegisterRaw) Returns the internal metadata register field.
void	setName(String name) Setter method for name attribute.
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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WrapperMetaArrayRawVO

public WrapperMetaArrayRawVO()

Empty WrapperMetaArrayRawVO constructor.

WrapperMetaArrayRawVO

public WrapperMetaArrayRawVO(String name,
                             String mapping,
                             boolean nullable,
                             int sortable,
                             boolean updateable)

WrapperMetaArrayRawVO constructor.

Parameters:

name - The name of the WrapperMetaArrayRawVO object.

mapping - The mapping of the WrapperMetaArrayRawVO object.

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.

WrapperMetaArrayRawVO

public WrapperMetaArrayRawVO(String name,
                             WrapperMetaRegisterRawVO registerRaw,
                             boolean mandatoryStatus,
                             boolean nullable,
                             int sortable,
                             boolean updateable,
                             boolean searchStatus)

WrapperMetaArrayRawVO constructor.

Parameters:

name - The metadatafield name.

registerRaw - The internal WrapperMetaRegisterRawVO metadata field.

mandatoryStatus - true when this is a searchable mandatory field

searchStatus - true when this is a searchable 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.

Method Detail

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:

4.7

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:

4.7

getName

public String getName()

Getter method for name attribute.

Specified by:

getName in interface WrapperMetaRawValueVO

Returns:

The metadata field name.

setName

public void setName(String name)

Setter method for name attribute.

Specified by:

setName in interface WrapperMetaRawValueVO

Parameters:

name -

getMapping

public String getMapping()

Getter method for mapping property.

Specified by:

getMapping in interface WrapperMetaRawValueVO

Returns:

the mapping value

setMapping

public void setMapping(String mapping)

Setter method for mapping property.

Specified by:

setMapping in interface WrapperMetaRawValueVO

Parameters:

mapping -

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)

getRawType

public int getRawType()

The int WrapperMetaArrayRawVO identifier.

Specified by:

getRawType in interface WrapperMetaRawValueVO

Returns:

int code.

getMetaRegister

public WrapperMetaRegisterRawVO getMetaRegister()

Getter method for the internal metadata register field

Returns:

The metadata register field

setMetaRegister

public void setMetaRegister(WrapperMetaRegisterRawVO metaRegisterRaw)

Returns the internal metadata register field.

Parameters:

metaRegisterRaw -

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

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()

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)

isEscape

public boolean isEscape()

Description copied from interface: WrapperMetaRawValueVO

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.

setEscape

public void setEscape(boolean escape)

Description copied from interface: WrapperMetaRawValueVO

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.

getIsTableField

public Boolean getIsTableField()

Returns:

the isTableField

setIsTableField

public void setIsTableField(Boolean isTableField)

Parameters:

isTableField - the isTableField to set

getIsCursorField

public Boolean getIsCursorField()

Returns:

the isCursorField

setIsCursorField

public void setIsCursorField(Boolean isCursorField)

Parameters:

isCursorField - the isCursorField to set

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 -

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 length)

Description copied from interface: WrapperMetaRawValueVO

Sets the maximum length value for the field.

Specified by:

setMaxLength in interface WrapperMetaRawValueVO

Parameters:

length - max length value.

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.

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

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

newInstance

public WrapperMetaArrayRawVO newInstance()

Creates a new WrapperMetaArrayRawVO

Returns:

a new WrapperMetaArrayRawVO

Since:

3.5