com.axemble.vdoc.sdk.components

Class MappingStructure

java.lang.Object

com.axemble.vdoc.sdk.components.MappingStructure

All Implemented Interfaces:

IMappingStructure, IMappingValuesProvider

Direct Known Subclasses:

ParameterizedMappingStructure

public class MappingStructure
extends Object
implements IMappingStructure, IMappingValuesProvider

Constructor Summary

Constructors

Constructor and Description
MappingStructure(String name, String label, String description, String dataType, boolean isMandatory, boolean isVisible, int mappingType, List<IMappingStructure> childValues, List<IOptionList.IOption> options)

Method Summary

Modifier and Type	Method and Description
List<IMappingStructure>	getChildValues() Retrieves childs mappingStructure for a composite mappingStructure.
String	getDataType() Retrieves the data type of the mappingStructure.
String	getDescription() Retrieves the description of the mappingStructure.
String	getLabel() Retrieves the label of the mappingStructure.
List<IOptionList.IOption>	getListOptions() Retrieves options displayed on the selection "value of list" in the mapping component.
int	getMappingType() Retrieves the mapping type of the mappingStructure.
String	getName() Retrives the name of mappingStructure.
List<IMappingStructure>	getValues() Retrieves childs mappingStructure for a composite mappingStructure.
boolean	isMandatory() Get if the value of mappingStructure is mandatory.
boolean	isVisible() Get if mappingStructure is default visible in the mapping component
void	setChildValues(List<IMappingStructure> childValues) Sets childs mappingStructure for a composite mappingStructure.
void	setDataType(String dataType) Sets the data type of the mappingStructure.
void	setDescription(String description) Sets a description to a mappingStructure.
void	setLabel(String label) Sets a label to a mappingStructure.
void	setListOptions(List<IOptionList.IOption> options) Sets options displayed on the selection "value of list" in the mapping component.
void	setMandatory(boolean isMandatory) Set if the value of mappingStructure is mandatory
void	setMappingType(int mappingType) Sets the mapping type of the mappingStructure.
void	setName(String name) Sets a name to the mappingStructure.
void	setVisible(boolean isVisible) Set if mappingStructure is visible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MappingStructure

public MappingStructure(String name,
                        String label,
                        String description,
                        String dataType,
                        boolean isMandatory,
                        boolean isVisible,
                        int mappingType,
                        List<IMappingStructure> childValues,
                        List<IOptionList.IOption> options)

Method Detail

getName

public String getName()

Description copied from interface: IMappingStructure

Retrives the name of mappingStructure.

Specified by:

getName in interface IMappingStructure

Returns:

A java.lang.String value with mappingStructure name.

getLabel

public String getLabel()

Description copied from interface: IMappingStructure

Retrieves the label of the mappingStructure.

Specified by:

getLabel in interface IMappingStructure

Returns:

A java.lang.String value with object label.

getDescription

public String getDescription()

Description copied from interface: IMappingStructure

Retrieves the description of the mappingStructure.

Specified by:

getDescription in interface IMappingStructure

Returns:

A java.lang.String value with object description.

getDataType

public String getDataType()

Description copied from interface: IMappingStructure

Retrieves the data type of the mappingStructure.

Specified by:

getDataType in interface IMappingStructure

Returns:

A IMappingProvider.DataType value with data type of the mappingStructure.

getChildValues

public List<IMappingStructure> getChildValues()

Description copied from interface: IMappingStructure

Retrieves childs mappingStructure for a composite mappingStructure.

Specified by:

getChildValues in interface IMappingStructure

Returns:

A java.util.List of IMappingStructure object

isMandatory

public boolean isMandatory()

Description copied from interface: IMappingStructure

Get if the value of mappingStructure is mandatory.

Specified by:

isMandatory in interface IMappingStructure

Returns:

isMandatory

isVisible

public boolean isVisible()

Description copied from interface: IMappingStructure

Get if mappingStructure is default visible in the mapping component

Specified by:

isVisible in interface IMappingStructure

Returns:

isVisible

getMappingType

public int getMappingType()

Description copied from interface: IMappingStructure

Retrieves the mapping type of the mappingStructure.

Specified by:

getMappingType in interface IMappingStructure

Returns:

A IMappingProvider.IMappingType value with data type of the mappingStructure.

getValues

public List<IMappingStructure> getValues()

Description copied from interface: IMappingStructure

Retrieves childs mappingStructure for a composite mappingStructure.

Specified by:

getValues in interface IMappingStructure

Specified by:

getValues in interface IMappingValuesProvider

Returns:

A java.util.List of IMappingStructure object

getListOptions

public List<IOptionList.IOption> getListOptions()

Description copied from interface: IMappingStructure

Retrieves options displayed on the selection "value of list" in the mapping component.

Specified by:

getListOptions in interface IMappingStructure

Returns:

A java.util.List of IOptionList.IOption object

setName

public void setName(String name)

Description copied from interface: IMappingStructure

Sets a name to the mappingStructure.

Specified by:

setName in interface IMappingStructure

Parameters:

name - The name of the mappingStructure.

setLabel

public void setLabel(String label)

Description copied from interface: IMappingStructure

Sets a label to a mappingStructure.

Specified by:

setLabel in interface IMappingStructure

Parameters:

label - The label of the mappingStructure.

setDescription

public void setDescription(String description)

Description copied from interface: IMappingStructure

Sets a description to a mappingStructure.

Specified by:

setDescription in interface IMappingStructure

Parameters:

description - The description of the mappingStructure.

setDataType

public void setDataType(String dataType)

Description copied from interface: IMappingStructure

Sets the data type of the mappingStructure.

Specified by:

setDataType in interface IMappingStructure

Parameters:

dataType - A value of the IMappingProvider.DataType.

setMandatory

public void setMandatory(boolean isMandatory)

Description copied from interface: IMappingStructure

Set if the value of mappingStructure is mandatory

Specified by:

setMandatory in interface IMappingStructure

setVisible

public void setVisible(boolean isVisible)

Description copied from interface: IMappingStructure

Set if mappingStructure is visible

Specified by:

setVisible in interface IMappingStructure

setMappingType

public void setMappingType(int mappingType)

Description copied from interface: IMappingStructure

Sets the mapping type of the mappingStructure.

Specified by:

setMappingType in interface IMappingStructure

Parameters:

mappingType - A value of the IMappingProvider.IMappingType.

setChildValues

public void setChildValues(List<IMappingStructure> childValues)

Description copied from interface: IMappingStructure

Sets childs mappingStructure for a composite mappingStructure.

Specified by:

setChildValues in interface IMappingStructure

Parameters:

childValues - A java.util.List of IMappingStructure object

setListOptions

public void setListOptions(List<IOptionList.IOption> options)

Description copied from interface: IMappingStructure

Sets options displayed on the selection "value of list" in the mapping component.

Specified by:

setListOptions in interface IMappingStructure

Parameters:

options - A java.util.List of IOptionList.IOption object