Package com.iizix.ws.prop.xml.schema

Class SchemaComponent

java.lang.Object

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

com.iizix.prop.PropCnr

com.iizix.ws.prop.xml.schema.SchemaComponent

All Implemented Interfaces:

EventListener, IGProp<GProp<?>[]>, IPropCnr, java.lang.Cloneable

Direct Known Subclasses:

ComplexType, ElementDeclaration, Facet, ModelGroup, SimpleType

public abstract class SchemaComponent
extends PropCnr

The Schema component property container is the base class for the schema components.

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
SchemaComponent()	Creates a new unnamed schema component.
SchemaComponent(Atom atom)	Creates a new named schema component.

Method Summary

Modifier and Type	Method	Description
void	addComponent(SchemaComponent comp)	Adds a schema component.
void	addComponent(SchemaComponent comp, java.lang.String base)	Adds a schema component.
abstract void	buildMessage(IMessageBuilder messageBuilder, javax.xml.soap.SOAPElement parent, javax.xml.soap.SOAPElement current, boolean isProduction)	Builds the SOAP message to send it.
SchemaComponent	clone()	Clones the instance.
protected java.lang.String	getBaseName(SchemaComponent comp)	Gets the base name for multiple schema components of a certain type.
java.lang.String	getElementID()	Gets the ID of the schema element.
java.lang.String	getLocalName()	Gets the local name.
javax.xml.namespace.QName	getName()	Gets the Type name.
javax.xml.namespace.QName	getName(IMessageBuilder messageBuilder)	Gets the Type name.
void	setInt(java.lang.String name, java.math.BigInteger bigInteger)	Sets a BigInteger value to a maximized int value.
void	setName(javax.xml.namespace.QName qname)	Names the property.
boolean	usesPropIndex()	Schema properties use index.

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, getPossibleChildren, getPredefinedProps, 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, 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, shouldSerializeToXML, toElementString, toNativeValue0, usePropHashMap, 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.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, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onRemoteEvent, removePropError, removePropListener, renameProp, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from interface com.iizix.prop.IPropCnr

canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized

Constructor Detail

SchemaComponent

public SchemaComponent()

Creates a new unnamed schema component.

SchemaComponent

public SchemaComponent(Atom atom)

Creates a new named schema component.

Parameters:

atom - The name.

Method Detail

usesPropIndex

public final boolean usesPropIndex()

Schema properties use index.

Specified by:

usesPropIndex in interface IPropCnr

Overrides:

usesPropIndex in class PropCnr

Returns:

true if index is used, false for non-index based container.

setName

public final void setName(javax.xml.namespace.QName qname)

Names the property.

Parameters:

qname - The name.

getName

public final javax.xml.namespace.QName getName()

Gets the Type name.

Returns:

The QName, or null if not defined.

getName

public final javax.xml.namespace.QName getName(IMessageBuilder messageBuilder)
                                        throws javax.xml.soap.SOAPException

Gets the Type name. The name is prefixed using the message builder.

Parameters:

messageBuilder - The message builder.

Returns:

The QName, or null if not defined.

Throws:

javax.xml.soap.SOAPException - If the name is in error.

getLocalName

public final java.lang.String getLocalName()

Gets the local name.

Returns:

The name, or null if not defined.

getElementID

public java.lang.String getElementID()

Gets the ID of the schema element.

Returns:

null if not specified, otherwise the ID.

clone

public SchemaComponent clone()

Clones the instance.

Overrides:

clone in class PropCnr

setInt

public void setInt(java.lang.String name,
                   java.math.BigInteger bigInteger)

Sets a BigInteger value to a maximized int value. If the value is null, the IntProp("name") is not set.

Parameters:

name - The IntProp name.

bigInteger - The BigInteger to read, null for none.

getBaseName

protected java.lang.String getBaseName(SchemaComponent comp)

Gets the base name for multiple schema components of a certain type. Override to provide support for multiple schema components to be added.

Parameters:

comp - Component to rename.

Returns:

The base name for the property to rename it, or null to skip rename.

addComponent

public final void addComponent(SchemaComponent comp)
                        throws BuildSchemaException

Adds a schema component. This method can be overridden to support renaming of schema components.

Parameters:

comp - Component to add.

Throws:

BuildSchemaException - If the properties cannot be built.

addComponent

public final void addComponent(SchemaComponent comp,
                               java.lang.String base)
                        throws BuildSchemaException

Adds a schema component. This method can be overridden to support renaming of schema components.

Parameters:

comp - Component to add.

base - Base name for rename.

Throws:

BuildSchemaException - If the properties cannot be built.

buildMessage

public abstract void buildMessage(IMessageBuilder messageBuilder,
                                  javax.xml.soap.SOAPElement parent,
                                  javax.xml.soap.SOAPElement current,
                                  boolean isProduction)
                           throws PropException,
                                  javax.xml.soap.SOAPException

Builds the SOAP message to send it.

Parameters:

messageBuilder - The message builder.

parent - The parent element.

current - The current element, null if not already created.

isProduction - Flag indicating the data is "production data" as opposed to sample/template.

Throws:

PropException - For build error of a property.

javax.xml.soap.SOAPException - For SOAP errors.