com.iizix.ws.prop

Class OutputProps

java.lang.Object

com.iizix.prop.GProp<GProp<?>[]>

com.iizix.prop.PropCnr

com.iizix.ws.prop.OutputProps

All Implemented Interfaces:

EventListener, IClassInstantiationAtResolve, IGProp<GProp<?>[]>, IPropCnr, IReferrerParticipant, IVSAccessor, IVSParticipant, Cloneable

Direct Known Subclasses:

EditorOutputProps

public class OutputProps
extends PropCnr
implements IVSParticipant, IClassInstantiationAtResolve

Output property that ties a result set from the execution of a Web Service request to VirtualSpace.

Author:

Christopher Mindus

Field Summary

Fields inherited from class com.iizix.prop.PropCnr

EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID

Fields inherited from class com.iizix.prop.GProp

GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2

Fields inherited from interface com.iizix.prop.IGProp

EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE

Constructor Summary

Constructors

Constructor and Description
OutputProps() Creates an Output property container with the specified name with a null value.
OutputProps(Atom propertyAtom) Creates a Output property container with the specified name with a null value.

Method Summary

Modifier and Type	Method and Description
protected void	addPredefinedProps() Adds the predefined properties for this container.
boolean	areUnicodeZeroWidthCharsIgnored() Checks if Unicode zero-width non-breaking space (0xFEFF) should be ignored.
OutputProps	clone() Clones this Output property container.
protected OutputVariables	createOutputVariables() Creates the output properties.
VSParticipant	createVSReference(Atom refAtom, PropCnr[] returnParent) Creates a VSReference instance from the container or any parent containers.
ClassReference	getClassReference() The Java class associated with result set output.
String	getDescription() Gets the result set description.
String	getEncoding() Gets the encoding.
IReplyProcessor	getMatchingProcessor(IReplyContent reply) Verifies if the reply matches the current output properties.
List<IReplyProcessor>	getMatchingProcessors(IReplyContent reply) Verifies if the reply matches the current output properties.
OutputVariables	getOutputVariables() Gets the output variables.
String	getParticipantDescription() Returns the given description of the referrer participant.
String	getParticipantType() Returns the given type of the referrer participant.
protected void	getPredefinedProps() Gets potential references to predefined properties for this container.
VSParticipant	getTargetVirtualSpaceParticipant() Gets the target VirtualSpace participant for output data.
VirtualSpace	getVirtualSpace() Gets the VirtualSpace.
VSParticipant	getVSReference(Atom refAtom) Gets a VSReference instance from the container or any parent containers.
WebServiceProp	getWebServiceProp() Gets the Web Service property.
boolean	isHTMLAccepted() Verifies if the HTML text is accepted.
boolean	isJSONAccepted() Verifies if JSON is accepted.
boolean	isPlainTextAccepted() Verifies if the Plain Text is accepted.
boolean	isXMLAccepted() Verifies if the XML is accepted.
void	onVirtualSpaceVirtualized(IAppSessionGyro appGyro, VirtualSpace virtualizedVirtualSpace) Called when the VirtualSpace has been virtualized, giving the opportunity for e.g.

Methods inherited from class com.iizix.prop.PropCnr

__transferChildProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, doPropEqualsArrayValues, doVirtualizePropCnr, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldCreateProps, toElementString, toNativeValue0, usePropHashMap, usesPropIndex, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verify, verifyInternalUseOnly, verifyTree, virtualize

Methods inherited from class com.iizix.prop.GProp

addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.iizix.prop.vs.IVSParticipant

assignVirtualSpace, getVSParticipantAtom

Methods inherited from interface com.iizix.prop.IReferrerParticipant

isParticipating, isPrimaryParticipant

Methods inherited from interface com.iizix.prop.IPropCnr

addProp, addProp, addProp2, addProp2, canRequestFocus, canRequestFocus, canRequestFocus, containsProp, containsProp, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, enablePropCommunication, enablePropHashMap, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsError, getExtendsName, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getString, getString, getString, getString, hasFocus, initializeExtendsFramework, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsRoot, isPropAddRemoveAllowed, isPropExtended, isSibling, removeAllProps, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, requestFocus, requestFocusEx, setBool, setBool, setBool, setBool, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, usePropHashMap, usesPropIndex, validateClassInstances

Methods inherited from interface com.iizix.prop.IGProp

addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getParent, getParent, getPropAtom, getPropBaseReference, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getReferences, getRelativePropName, getRootParent, getTreeLock, getValueClasses, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPropTreeInitialized, onRemoteEvent, removePropError, removePropListener, renameProp, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toElementString, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropType, validatePropValue, verify, verifyHasPropertyItem, warning, warning, warning

Methods inherited from interface com.iizix.prop.IClassInstantiationAtResolve

shouldInstantiateAtResolve

Constructor Detail

OutputProps

public OutputProps()

Creates an Output property container with the specified name with a null value.

OutputProps

public OutputProps(Atom propertyAtom)

Creates a Output property container with the specified name with a null value.

Parameters:

propertyAtom - the property atom.

Method Detail

createOutputVariables

protected OutputVariables createOutputVariables()

Creates the output properties.

getOutputVariables

public OutputVariables getOutputVariables()

Gets the output variables.

Returns:

The output variables instance.

addPredefinedProps

protected void addPredefinedProps()
                           throws PropException

Adds the predefined properties for this container. This method is called once just after construction of the property container.

Properties added:

  - InputProps as Atom.INPUT
 

Overrides:

addPredefinedProps in class PropCnr

Throws:

PropException - for property exceptions.

getPredefinedProps

protected void getPredefinedProps()

Gets potential references to predefined properties for this container. This method is called once just after cloning of the property container.

The method should get reference to using the getProp(...) methods. This allows the subclass to be able to retrieve the new instances to the properties created during addPredefinedProps() if stored in instance variables.

Overrides:

getPredefinedProps in class PropCnr

clone

public OutputProps clone()

Clones this Output property container.

Overrides:

clone in class PropCnr

getWebServiceProp

public WebServiceProp getWebServiceProp()

Gets the Web Service property.

Returns:

The Web Service property, or null if this property is orphaned.

getDescription

public String getDescription()

Gets the result set description.

Returns:

A description, or null for none.

getEncoding

public String getEncoding()

Gets the encoding.

Returns:

The encoding, default "UTF-8".

areUnicodeZeroWidthCharsIgnored

public boolean areUnicodeZeroWidthCharsIgnored()

Checks if Unicode zero-width non-breaking space (0xFEFF) should be ignored.

Returns:

Flag for ignoring these characters, true by default.

isPlainTextAccepted

public boolean isPlainTextAccepted()

Verifies if the Plain Text is accepted.

Returns:

true if plain text is OK.

isHTMLAccepted

public boolean isHTMLAccepted()

Verifies if the HTML text is accepted.

Returns:

true if HTML is OK.

isXMLAccepted

public boolean isXMLAccepted()

Verifies if the XML is accepted.

Returns:

true if XML is OK.

isJSONAccepted

public boolean isJSONAccepted()

Verifies if JSON is accepted.

Returns:

true if JSON is OK.

getParticipantDescription

public String getParticipantDescription()

Returns the given description of the referrer participant.

Specified by:

getParticipantDescription in interface IReferrerParticipant

getParticipantType

public String getParticipantType()

Returns the given type of the referrer participant.

Specified by:

getParticipantType in interface IReferrerParticipant

getVSReference

public VSParticipant getVSReference(Atom refAtom)

Gets a VSReference instance from the container or any parent containers. The method is used by VSRelativeReference to look up the VSReference instance in order to resolve the relative path to the target property.

Specified by:

getVSReference in interface IGProp<GProp<?>[]>

Overrides:

getVSReference in class PropCnr

Parameters:

refAtom - The property atom of the requesting relative reference property.

Returns:

The instance of the VSReference or null if unassigned.

createVSReference

public VSParticipant createVSReference(Atom refAtom,
                                       PropCnr[] returnParent)

Creates a VSReference instance from the container or any parent containers. The method is used in the Designer to create a VirtualSpace connection for VSRelativeReference to look up the VSReference instance in order to resolve the relative path to the target property.

This method needs to be overridden by subclasses of PropCnr that has a VSReference as property, and *SHOULD* match getVSReference(Atom).

The default is to re-target the call to the parent container, and if the root, a folder or a file property is reached, null is returned.

Overrides:

createVSReference in class PropCnr

Parameters:

refAtom - The property asking for the VSReference.

returnParent - An array of PropCnr [1] that will be filled in with the parent property of the VSRefernce.

Returns:

The instance of the VSReference or null if unassigned. The returned instance could also be a VSParticipant and should therefore be processed accordingly.

For this method, it's a VSParticipant.

getVirtualSpace

public VirtualSpace getVirtualSpace()

Gets the VirtualSpace.

Specified by:

getVirtualSpace in interface IVSAccessor

Returns:

The VirtualSpace connected to the result set, or null for none.

getTargetVirtualSpaceParticipant

public VSParticipant getTargetVirtualSpaceParticipant()

Gets the target VirtualSpace participant for output data.

Returns:

The target VirtualSpace participating with the output data, null for none.

getClassReference

public ClassReference getClassReference()

The Java class associated with result set output.

Returns:

The ClassReference instance, or null for none.

getMatchingProcessor

public IReplyProcessor getMatchingProcessor(IReplyContent reply)

Verifies if the reply matches the current output properties.

Parameters:

reply - The reply contents.

Returns:

The first matching processor, null for none.

getMatchingProcessors

public List<IReplyProcessor> getMatchingProcessors(IReplyContent reply)

Verifies if the reply matches the current output properties.

Parameters:

reply - The reply contents.

Returns:

The list of matching processors.

onVirtualSpaceVirtualized

public void onVirtualSpaceVirtualized(IAppSessionGyro appGyro,
                                      VirtualSpace virtualizedVirtualSpace)

Called when the VirtualSpace has been virtualized, giving the opportunity for e.g. data connectors to prepare it's virtualized counterparts if this is required.

This call is done to the non-virtualized instance of the VirtualSpace participant.

Specified by:

onVirtualSpaceVirtualized in interface IVSParticipant

Parameters:

appGyro - The application gyro instance.

virtualizedVirtualSpace - The virtualized VirtualSpace instance.