Package com.iizigo.ws.prop.json
Class EditorJSONReplyDocument
- java.lang.Object
- com.iizix.prop.GProp<GProp<?>[]>
- com.iizix.prop.PropCnr
- com.iizix.ws.prop.json.JSONReplyDocument
- com.iizigo.ws.prop.json.EditorJSONReplyDocument
- All Implemented Interfaces:
IPropDesigner
,IEditorReplyProcessor
,IWSPropDesigner
,EventListener
,IGProp<GProp<?>[]>
,IPropCnr
,IReplyProcessor
,java.lang.Cloneable
,org.eclipse.core.runtime.IAdaptable
public class EditorJSONReplyDocument extends JSONReplyDocument implements IWSPropDesigner, IEditorReplyProcessor
Editor version of the JSON reply document contains information that identifies the reply transaction and maps the structured data into VSFields and VSTables (or columns).- 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 Description EditorJSONReplyDocument()
Creates the property container without a name.EditorJSONReplyDocument(Atom propertyAtom)
Creates the property container with the specified name.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EditorJSONReplyDocument
clone()
Clone must be overridden.boolean
couldBecomeProcessor(IReplyContent reply)
Verifies if this processor could potentially become a valid processor if it receives identification information.org.eclipse.swt.widgets.Composite
createCNToolTip(org.eclipse.swt.widgets.Composite parent)
Creates a tooltip for the input variables.PropCnr
createFirstProcessorIdentification(EditorOutputProps output, IReplyContent reply)
Creates the required identification properties to start to become a valid processor.void
createWrapper()
Create the wrapper if not done.java.lang.String
getCNDescriptionType()
Provide a type description for the status bar view, if available.org.eclipse.swt.graphics.Image
getCNImage()
Gets the image for the Common Navigator.java.lang.String
getCNText()
Gets the label text for the Common Navigator.WebServiceDesignerProp
getDesigner()
Gets the Designer Extension for Properties.JSONObject
getDocument()
Gets the JSON document.java.lang.String
getDocumentString()
Gets the Document String.EditorOutputProps
getOutput()
Gets the output properties.java.lang.Class<?>[]
getPossibleChildren()
Gets the acceptable children property classes that can be used in conjunction with e.g.EditorVirtualSpace
getVirtualSpace()
Gets the VirtualSpace.EditorWebServiceProp
getWebServiceProp()
Gets the Web Service property.boolean
processReply(WebServiceEditor editor, EditorOutputProps output, boolean doPerform, java.util.List<VSComponent> list, java.util.Map<VSComponent,java.lang.Throwable> errors)
Processes a stored reply contents.boolean
setDocument(JSONObject doc)
Sets the Document from a Reply.DesignerProp
setReply(IReplyContent reply)
Updates the output for the processor with a new reply that should replace the old one.boolean
verify(PropVerification verification)
Verifies this property container.Methods inherited from class com.iizix.ws.prop.json.JSONReplyDocument
getDescription, getFailureMessage, getReplyMatch, processReply, processReply, shouldCreateProps
Methods inherited from class com.iizix.prop.PropCnr
__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, 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, getPredefinedProps, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, 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, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, 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, shouldSerializeToXML, toElementString, toNativeValue0, usePropHashMap, usesPropIndex, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, 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, getModuleFolder, getModuleFolder, 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.iizigo.ws.editor.IEditorReplyProcessor
getDescription
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, getModuleFolder, getModuleFolder, getParent, getParent, getPropAtom, getPropBaseReference, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getReferences, getRelativePropName, getRootParent, getTreeLock, getValueClasses, getVSReference, 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, verifyHasPropertyItem, warning, warning, warning
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, getProp, getProp, 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, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, 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.iizigo.prop.IPropDesigner
findIResource, getAdapter
Methods inherited from interface com.iizix.ws.api.IReplyProcessor
getFailureMessage, getReplyMatch, processReply
Methods inherited from interface com.iizigo.ws.prop.IWSPropDesigner
createCNToolTip, getCNImage, getCNText
Constructor Detail
EditorJSONReplyDocument
public EditorJSONReplyDocument()
Creates the property container without a name. The name must be set in all cases using thesetPropertyAtom
call.
EditorJSONReplyDocument
public EditorJSONReplyDocument(Atom propertyAtom)
Creates the property container with the specified name. All system-reserved names for components begins with "$".- Parameters:
propertyAtom
- the name of the component, unique within it's parent.
Method Detail
getDesigner
public WebServiceDesignerProp getDesigner()
Gets the Designer Extension for Properties.- Specified by:
getDesigner
in interfaceIPropDesigner
- Returns:
- The instance of the Designer Extension.
clone
public EditorJSONReplyDocument clone()
Clone must be overridden.- Overrides:
clone
in classJSONReplyDocument
- Returns:
- A cloned instance.
getDocumentString
public java.lang.String getDocumentString()
Gets the Document String.- Overrides:
getDocumentString
in classJSONReplyDocument
- Returns:
- The Document String when called in the Designer, null otherwise.
getDocument
public JSONObject getDocument()
Gets the JSON document. This method can only be used in the Designer.- Overrides:
getDocument
in classJSONReplyDocument
- Returns:
- The JSON Document, null when not used in the Designer.
setDocument
public boolean setDocument(JSONObject doc)
Sets the Document from a Reply. This method can only be used in the Designer.- Overrides:
setDocument
in classJSONReplyDocument
- Returns:
- true for changed document string, false for same contents or failure to save document.
createWrapper
public void createWrapper()
Create the wrapper if not done.
getOutput
public EditorOutputProps getOutput()
Gets the output properties.- Overrides:
getOutput
in classJSONReplyDocument
- Returns:
- The output properties.
getWebServiceProp
public EditorWebServiceProp getWebServiceProp()
Gets the Web Service property.- Overrides:
getWebServiceProp
in classJSONReplyDocument
- Returns:
- The Web Service property, or null if this property is orphaned.
getVirtualSpace
public EditorVirtualSpace getVirtualSpace()
Gets the VirtualSpace.- Overrides:
getVirtualSpace
in classJSONReplyDocument
- Returns:
- The VirtualSpace connected the the variable input, or null for none.
getPossibleChildren
public java.lang.Class<?>[] getPossibleChildren()
Gets the acceptable children property classes that can be used in conjunction with e.g. a Paste operation.- Specified by:
getPossibleChildren
in interfaceIPropCnr
- Overrides:
getPossibleChildren
in classPropCnr
- Returns:
- An array containing the classes of possible children, or null for no support.
getCNImage
public org.eclipse.swt.graphics.Image getCNImage()
Gets the image for the Common Navigator.- Specified by:
getCNImage
in interfaceIWSPropDesigner
- Returns:
- Image or
null
if there is no image.
getCNText
public java.lang.String getCNText()
Gets the label text for the Common Navigator.- Specified by:
getCNText
in interfaceIWSPropDesigner
- Returns:
- The text.
getCNDescriptionType
public java.lang.String getCNDescriptionType()
Provide a type description for the status bar view, if available.- Specified by:
getCNDescriptionType
in interfaceIWSPropDesigner
- Returns:
- A type description for the status bar view, or null if not available.
createCNToolTip
public org.eclipse.swt.widgets.Composite createCNToolTip(org.eclipse.swt.widgets.Composite parent)
Creates a tooltip for the input variables.- Specified by:
createCNToolTip
in interfaceIWSPropDesigner
- Parameters:
parent
- The parent composite.- Returns:
- The created composite in the parent.
processReply
public boolean processReply(WebServiceEditor editor, EditorOutputProps output, boolean doPerform, java.util.List<VSComponent> list, java.util.Map<VSComponent,java.lang.Throwable> errors)
Processes a stored reply contents.- Specified by:
processReply
in interfaceIEditorReplyProcessor
- Parameters:
editor
- The Editor.output
- The output properties.doPerform
- The reply contents.list
- List filled with propagated items.errors
- Map filled with errors.- Returns:
- true for success, false if not possible.
couldBecomeProcessor
public boolean couldBecomeProcessor(IReplyContent reply)
Verifies if this processor could potentially become a valid processor if it receives identification information.- Specified by:
couldBecomeProcessor
in interfaceIEditorReplyProcessor
- Parameters:
reply
- The reply contents.- Returns:
- Flag for processor is candidate.
createFirstProcessorIdentification
public PropCnr createFirstProcessorIdentification(EditorOutputProps output, IReplyContent reply)
Creates the required identification properties to start to become a valid processor.- Specified by:
createFirstProcessorIdentification
in interfaceIEditorReplyProcessor
- Parameters:
output
- The output properties.reply
- The reply.- Returns:
- The property container to process identifications.
setReply
public DesignerProp setReply(IReplyContent reply)
Updates the output for the processor with a new reply that should replace the old one.- Specified by:
setReply
in interfaceIEditorReplyProcessor
- Parameters:
reply
- The reply.- Returns:
- The DesignerProp that shows the output in the tree.
verify
public boolean verify(PropVerification verification)
Verifies this property container. The check performed is the extension of classes and that no circular reference is present.