com.iizigo.ws.prop

Interface IWrappedElement

All Superinterfaces:

IWSPropDesigner

All Known Implementing Classes:

EditorJSONElementWrapper, EditorXMLElementWrapper

public interface IWrappedElement
extends IWSPropDesigner

Interface for a wrapped element.

Author:

Christopher Mindus

Method Summary

Modifier and Type	Method and Description
boolean	canCombineSelection(GProp<?>[] props) Checks if the element can be combined in a selection with other properties.
boolean	canMapToVSField() Verifies if the element is potentially not a repeated value that can be placed in a VS Field.
boolean	canMapToVSTableColumn() Verifies if the element is potentially a repeated value that can be placed in a VS Table Column.
Composite	createComposite(WebServiceEditor editor, Composite parent, Composite existingComposite, GProp<?>[] props) Creates the composite to show.
Value.Type	getValueType() Gets the Value type that applies for this element.
String	getWrappedElementValue() Gets the wrapped element value.
String	getWrappedReference(boolean attempIndex) Gets the reference of this wrapped element.
boolean	isRepeated() Checks if an element that can be mapped to a column is perhaps repeated.

Methods inherited from interface com.iizigo.ws.prop.IWSPropDesigner

createCNToolTip, createCNToolTip, getCNDescriptionType, getCNImage, getCNImage, getCNText, getCNText

Method Detail

canCombineSelection

boolean canCombineSelection(GProp<?>[] props)

Checks if the element can be combined in a selection with other properties.

Parameters:

props - The selected properties (at least one [itself - this]).

Returns:

The flag.

createComposite

Composite createComposite(WebServiceEditor editor,
                          Composite parent,
                          Composite existingComposite,
                          GProp<?>[] props)

Creates the composite to show. The property editor must be disposed of if required.

Parameters:

editor - The editor.

parent - Parent composite.

existingComposite - The existing composite for wrapped elements, null for none.

props - The selected properties (at least one).

Returns:

The composite for to show.

getWrappedReference

String getWrappedReference(boolean attempIndex)

Gets the reference of this wrapped element.

Parameters:

attempIndex - Flag indicating index is required if possible.

Returns:

A reference such as "xml:/path" where an element that could be a row element is assigned the row index.

getWrappedElementValue

String getWrappedElementValue()

Gets the wrapped element value.

Returns:

The wrapped element value, or null for none.

canMapToVSField

boolean canMapToVSField()

Verifies if the element is potentially not a repeated value that can be placed in a VS Field. For e.g. XML, there is often no way of knowing this unless there is an XML Schema (XSD) present. For JSON, it is obvious if it's not an Array.

Returns:

The flag.

canMapToVSTableColumn

boolean canMapToVSTableColumn()

Verifies if the element is potentially a repeated value that can be placed in a VS Table Column. For e.g. XML, there is often no way of knowing this unless there is an XML Schema (XSD) present. For JSON, it is obvious if it's an Array.

Returns:

The flag.

isRepeated

boolean isRepeated()

Checks if an element that can be mapped to a column is perhaps repeated. Such elements will prefer creation of VS Table Columns instead of VS Fields as default operation.

Returns:

The flag.

getValueType

Value.Type getValueType()

Gets the Value type that applies for this element.

Returns:

The value type to use, or null if it can't be connected at all.