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

Class WrapperMetaRegisterRawVO

java.lang.Object

com.denodo.vdb.vdbinterface.common.clientResult.vo.MessageVO

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

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

All Implemented Interfaces:

WrapperMetaRawValueVO, Serializable

Direct Known Subclasses:

HTMLWrapperMetaRegisterRawVO

public class WrapperMetaRegisterRawVO
extends VDBObject
implements WrapperMetaRawValueVO

WrapperMetaRawValueVO implementation that will contains a set of other WrapperMetaRawValueVO objects.

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
WrapperMetaRegisterRawVO() Empty constructor of WrapperMetaRegisterRawVO
WrapperMetaRegisterRawVO(String name, boolean mandatoryStatus, boolean nullable, int sortable, boolean updateable, boolean searchStatus) WrapperMetaRegisterRawVO constructor.
WrapperMetaRegisterRawVO(String name, String mapping, boolean mandatoryStatus, boolean nullable, int sortable, boolean updateable, boolean searchStatus) WrapperMetaRegisterRawVO constructor.
WrapperMetaRegisterRawVO(String name, String mapping, boolean nullable, int sortable, boolean updateable) WrapperMetaRegisterRawVO 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.
void	add(WrapperMetaRawValueVO value) Adds a new WrapperMetaRawValueVO to the WrapperMetaRegisterRawVO object.
void	addAtBeginning(WrapperMetaRawValueVO value) Adds a WrapperMetaRawValueVO at beginning.
Object	copy() Obtains a copy of this object.
List<WrapperMetaArrayRawVO>	getArrayFields() Returns the internal metadata array fields (instances of WrapperMetaArrayRawVO)
String	getMapping() Getter for WrapperMetaRegisterRawVO mapping property.
Integer	getMaxLength() Gets the maximum length value for the field.
Set<String>	getMetaRawNames() Returns the set of internal WrapperMetaRawValueVO indexed names.
WrapperMetaRawValueVO	getMetaRawValue(String key) Returns a internal WrapperMetaRawValueVO indexed with the key parameter.
WrapperMetaRawValueVO	getMetaRawValueByMapping(String key) Returns a internal WrapperMetaRawValueVO with mapping equals to parameter.
List<WrapperMetaRawValueVO>	getMetaRawValues() Returns the set of internal WrapperMetaRawValueVO instances.
AbstractMap<String,WrapperMetaRawValueVO>	getMetaRawValuesMap() Returns the map of internal WrapperMetaRawValueVO instances.
int	getNumOfMetaRawValues() Returns the size of the internal metadata fields.
Integer	getParameterIndex() Gets the parameter index of a field.
HashMap<String,String>	getPropertiesMap()
int	getRawType() Returns the WrapperMetaRegisterRawVO integer type
List<WrapperMetaRegisterRawVO>	getRegisterFields() Returns the internal metadata register fields (instances of WrapperMetaRegisterRawVO)
Integer	getResultSetIndex()
List<WrapperMetaSimpleRawVO>	getSimpleFields() Returns the internal metadata simple fields (instances of WrapperMetaSimpleRawVO)
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.
WrapperMetaRegisterRawVO	newInstance() Obtains a new WrapperMetaRegisterRawVO
void	remove(String keyValue) Remove a WrapperMetaRawValueVO with a specific name
void	resetMetaRawValues(List<WrapperMetaRawValueVO> metaRawValueVOs) Set the internal WrapperMetaRawValueVO instances to the new list clearing the previous values.
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	setMandatoryStatus(boolean mandatoryStatus) Setter for mandatoryStatus attribute.
void	setMapping(String mapping) Setter for WrapperMetaRegisterRawVO mapping property.
void	setMaxLength(Integer maxLength) Sets the maximum length value for the field.
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.
void	updateMapKeys() Regenerates the MetaRawValueVO Map with values from MetaRawValueVO list.
void	updateMetaRawValueKey(String key, String newKey) Updates the key of an internal WrapperMetaRawValueVO.

Methods inherited from class com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.VDBObject

copyProperties, getId, getName, isGenerateVQL, setGenerateVQL, setId, setName

Methods inherited from class java.lang.Object

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

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

getName, setName

Constructor Detail

WrapperMetaRegisterRawVO

public WrapperMetaRegisterRawVO()

Empty constructor of WrapperMetaRegisterRawVO

WrapperMetaRegisterRawVO

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

WrapperMetaRegisterRawVO constructor.

Parameters:

name - The name of the WrapperMetaRegisterRawVO object.

mapping - The mapping of the WrapperMetaRegisterRawVO 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.

WrapperMetaRegisterRawVO

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

WrapperMetaRegisterRawVO constructor.

Parameters:

name - The name of the WrapperMetaRegisterRawVO 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.

searchStatus - true when this is a searchable field

WrapperMetaRegisterRawVO

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

WrapperMetaRegisterRawVO constructor.

Parameters:

name - The name of the WrapperMetaRegisterRawVO object.

mapping - The mapping of the WrapperMetaRegisterRawVO 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.

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

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

getMapping

public String getMapping()

Getter for WrapperMetaRegisterRawVO mapping property.

Specified by:

getMapping in interface WrapperMetaRawValueVO

Returns:

Returns the mapping.

setMapping

public void setMapping(String mapping)

Setter for WrapperMetaRegisterRawVO mapping property.

Specified by:

setMapping in interface WrapperMetaRawValueVO

Parameters:

mapping - The mapping 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)

getRawType

public int getRawType()

Returns the WrapperMetaRegisterRawVO integer type

Specified by:

getRawType in interface WrapperMetaRawValueVO

Returns:

int code

remove

public void remove(String keyValue)

Remove a WrapperMetaRawValueVO with a specific name

Parameters:

keyValue - Name to index the value.

add

public void add(WrapperMetaRawValueVO value)

Adds a new WrapperMetaRawValueVO to the WrapperMetaRegisterRawVO object. This metadata object is internally indexed with its getName() property.

Parameters:

value - The new metadata object to add.

addAtBeginning

public void addAtBeginning(WrapperMetaRawValueVO value)

Adds a WrapperMetaRawValueVO at beginning.

Parameters:

value -

getMetaRawNames

public Set<String> getMetaRawNames()

Returns the set of internal WrapperMetaRawValueVO indexed names.

Returns:

The set of names as Strings.

getMetaRawValues

public List<WrapperMetaRawValueVO> getMetaRawValues()

Returns the set of internal WrapperMetaRawValueVO instances.

Returns:

The set of WrapperMetaRawValueVO objects.

resetMetaRawValues

public void resetMetaRawValues(List<WrapperMetaRawValueVO> metaRawValueVOs)

Set the internal WrapperMetaRawValueVO instances to the new list clearing the previous values.

getMetaRawValuesMap

public AbstractMap<String,WrapperMetaRawValueVO> getMetaRawValuesMap()

Returns the map of internal WrapperMetaRawValueVO instances.

Returns:

the map of internal WrapperMetaRawValueVO instances.

getMetaRawValue

public WrapperMetaRawValueVO getMetaRawValue(String key)

Returns a internal WrapperMetaRawValueVO indexed with the key parameter.

Parameters:

key - The indexed name of the requested WrapperMetaRawValueVO object (no case sensitive)

Returns:

The WrapperMetaRawValueVO object represented with the key or null if no object matching this key found.

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

getMetaRawValueByMapping

public WrapperMetaRawValueVO getMetaRawValueByMapping(String key)

Returns a internal WrapperMetaRawValueVO with mapping equals to parameter.

Parameters:

key - The indexed name of the requested WrapperMetaRawValueVO object (no case sensitive)

Returns:

The WrapperMetaRawValueVO object represented with the key or null if no object matching this key found.

updateMetaRawValueKey

public void updateMetaRawValueKey(String key,
                                  String newKey)

Updates the key of an internal WrapperMetaRawValueVO.

Parameters:

key - the old key.

newKey - the new key.

updateMapKeys

public void updateMapKeys()

Regenerates the MetaRawValueVO Map with values from MetaRawValueVO list.

getNumOfMetaRawValues

public int getNumOfMetaRawValues()

Returns the size of the internal metadata fields.

Returns:

The number of internal MetaRawValues.

getRegisterFields

public List<WrapperMetaRegisterRawVO> getRegisterFields()

Returns the internal metadata register fields (instances of WrapperMetaRegisterRawVO)

Returns:

The internal metadata register fields.

getSimpleFields

public List<WrapperMetaSimpleRawVO> getSimpleFields()

Returns the internal metadata simple fields (instances of WrapperMetaSimpleRawVO)

Returns:

The internal metadata simple fields.

getArrayFields

public List<WrapperMetaArrayRawVO> getArrayFields()

Returns the internal metadata array fields (instances of WrapperMetaArrayRawVO)

Returns:

The internal metadata array fields.

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.

See Also:

WrapperMetaRawValueVO.isEscape()

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.

See Also:

WrapperMetaRawValueVO.setEscape(boolean)

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.

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.

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 -

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

newInstance

public WrapperMetaRegisterRawVO newInstance()

Obtains a new WrapperMetaRegisterRawVO

Returns:

a new WrapperMetaRegisterRawVO

Since:

3.5

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