Package org.apache.axis.wsdl.symbolTable
Class TypeEntry
java.lang.Object
org.apache.axis.wsdl.symbolTable.SymTabEntry
org.apache.axis.wsdl.symbolTable.TypeEntry
- All Implemented Interfaces:
Serializable
This class represents a wsdl types entry that is supported by the WSDL2Java emitter.
A TypeEntry has a QName representing its XML name and a name, which in the
WSDL2Java back end is its full java name. The TypeEntry may also have a Node,
which locates the definition of the emit type in the xml.
A TypeEntry object extends SymTabEntry and is built by the SymbolTable class for
each supported root complexType, simpleType, and elements that are
defined or encountered.
SymTabEntry
|
TypeEntry
/ \
Type Element
| |
(BaseType, (DefinedElement,
CollectionType CollectionElement,
DefinedType, UndefinedElement)
UndefinedType)
UndefinedType and UndefinedElement are placeholders when the real type or element
is not encountered yet. Both of these implement the Undefined interface.
A TypeEntry whose java (or other language) name depends on an Undefined type, will
have its name initialization deferred until the Undefined type is replaced with
a defined type. The updateUndefined() method is invoked by the UndefinedDelegate to
update the information.
Each TypeEntry whose language name depends on another TypeEntry will have the refType
field set. For example:
The TypeEntry for "foo" will have a refType set to the TypeEntry of "bar".
Another Example:
<xsd:complexType name="hobbyArray">
<xsd:complexContent>
<xsd:restriction base="soapenc:Array">
<xsd:attribute ref="soapenc:arrayType" wsdl:arrayType="xsd:string[]"/>
</xsd:restriction>
</xsd:complexContent>
</xsd:complexType>
The TypeEntry for "hobbyArray" will have a refType that locates the TypeEntry for xsd:string
and the dims field will be "[]"
- Author:
- Rich Scheuerle (scheu@us.ibm.com)
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected QName
protected Vector
contained attributes in the schema's type definitionprotected Vector
contained elements in the schema's type definitionprotected String
Field dimsprotected boolean
Field isBaseTypeprotected boolean
Field isSimpleTypeprotected QName
If this TypeEntry represents an array with elements inside a "wrapper" this field can optionally change the inner QName (default is- ).
protected Node
Field nodeprotected boolean
Field onlyLiteralReferenceprotected TypeEntry
Field refTypeprotected HashSet
Field typesprotected boolean
Field undefinedprotected boolean
Fields inherited from class org.apache.axis.wsdl.symbolTable.SymTabEntry
name, qname
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Create a TypeEntry object for an xml construct name that represents a base typeprotected
Create a TypeEntry object for an xml construct that references another type.protected
Create a TypeEntry object for an xml construct that is not a base type -
Method Summary
Modifier and TypeMethodDescriptionReturns the Base Type Name.Return the QName of the component if this is an array typeReturn the dimensions of this type, which can be 0 or more "[]".getNestedTypes
(SymbolTable symbolTable, boolean derivedFlag) This method returns a set of all the nested types.getNode()
Query the node for this type.If this type references another type, return that type, otherwise return null.protected TypeEntry
getUndefinedTypeRef returns the Undefined TypeEntry that this entry depends on or NULL.boolean
Return whether the underlying type is nillable if this is an array type.boolean
Method isBaseTypeboolean
Is this type references ONLY as a literal type? If a binding's message's soapBody says: use="literal", then a type is referenced literally.boolean
Method isSimpleTypevoid
setBaseType
(boolean baseType) Method setBaseTypevoid
setComponentType
(QName componentType) Set the QName of the component if this is an array typevoid
setContainedAttributes
(Vector containedAttributes) void
setContainedElements
(Vector containedElements) void
setItemQName
(QName itemQName) void
setOnlyLiteralReference
(boolean set) Set the isOnlyLiteralReference flag.void
setRefType
(TypeEntry refType) Method setRefTypevoid
setSimpleType
(boolean simpleType) Method setSimpleTypevoid
setUnderlTypeNillable
(boolean underlTypeNillable) Set the boolean indicating whether underlying type of array is nillable.toString()
Get string representation.protected String
Get string representation with indentationprotected boolean
updateUndefined
(TypeEntry oldRef, TypeEntry newRef) UpdateUndefined is called when the ref TypeEntry is finally known.Methods inherited from class org.apache.axis.wsdl.symbolTable.SymTabEntry
getDynamicVar, getName, getQName, isReferenced, setDynamicVar, setIsReferenced, setName
-
Field Details
-
node
Field node -
refType
Field refType -
dims
Field dims -
underlTypeNillable
protected boolean underlTypeNillable -
componentType
-
itemQName
If this TypeEntry represents an array with elements inside a "wrapper" this field can optionally change the inner QName (default is- ).
-
undefined
protected boolean undefinedField undefined -
isBaseType
protected boolean isBaseTypeField isBaseType -
isSimpleType
protected boolean isSimpleTypeField isSimpleType -
onlyLiteralReference
protected boolean onlyLiteralReferenceField onlyLiteralReference -
types
Field types -
containedElements
contained elements in the schema's type definition -
containedAttributes
contained attributes in the schema's type definition
-
-
Constructor Details
-
TypeEntry
Create a TypeEntry object for an xml construct that references another type. Defer processing until refType is known.- Parameters:
pqName
-refType
-pNode
-dims
-
-
TypeEntry
Create a TypeEntry object for an xml construct that is not a base type- Parameters:
pqName
-pNode
-
-
TypeEntry
Create a TypeEntry object for an xml construct name that represents a base type- Parameters:
pqName
-
-
-
Method Details
-
getNode
Query the node for this type.- Returns:
-
getBaseType
Returns the Base Type Name. For example if the Type represents a schema integer, "int" is returned. If this is a user defined type, null is returned.- Returns:
-
isBaseType
public boolean isBaseType()Method isBaseType- Returns:
-
setBaseType
public void setBaseType(boolean baseType) Method setBaseType- Parameters:
baseType
-
-
isSimpleType
public boolean isSimpleType()Method isSimpleType- Returns:
-
setSimpleType
public void setSimpleType(boolean simpleType) Method setSimpleType- Parameters:
simpleType
-
-
isOnlyLiteralReferenced
public boolean isOnlyLiteralReferenced()Is this type references ONLY as a literal type? If a binding's message's soapBody says: use="literal", then a type is referenced literally. Note that that type's contained types (ie., an address contains a phone#) are not referenced literally. Since a type that is ONLY referenced as a literal may cause a generator to act differently (like WSDL2Java), this extra reference distinction is needed.- Returns:
-
setOnlyLiteralReference
public void setOnlyLiteralReference(boolean set) Set the isOnlyLiteralReference flag.- Parameters:
set
-
-
getUndefinedTypeRef
getUndefinedTypeRef returns the Undefined TypeEntry that this entry depends on or NULL.- Returns:
-
updateUndefined
UpdateUndefined is called when the ref TypeEntry is finally known.- Parameters:
oldRef
- The TypeEntry representing the Undefined TypeEntrynewRef
- The replacement TypeEntry- Returns:
- true if TypeEntry is changed in any way.
- Throws:
IOException
-
getRefType
If this type references another type, return that type, otherwise return null.- Returns:
-
setRefType
Method setRefType- Parameters:
refType
-
-
getDimensions
Return the dimensions of this type, which can be 0 or more "[]".- Returns:
-
getUnderlTypeNillable
public boolean getUnderlTypeNillable()Return whether the underlying type is nillable if this is an array type.- Returns:
- true if it is an array and nillable
-
setUnderlTypeNillable
public void setUnderlTypeNillable(boolean underlTypeNillable) Set the boolean indicating whether underlying type of array is nillable. -
getComponentType
Return the QName of the component if this is an array type- Returns:
- QName of array elements or null
-
setComponentType
Set the QName of the component if this is an array type -
getItemQName
-
setItemQName
-
toString
Get string representation.- Overrides:
toString
in classSymTabEntry
- Returns:
-
toString
Get string representation with indentation- Overrides:
toString
in classSymTabEntry
- Parameters:
indent
-- Returns:
-
getNestedTypes
This method returns a set of all the nested types. Nested types are types declared within this TypeEntry (or descendents) plus any extended types and the extended type nested types The elements of the returned HashSet are Types.- Parameters:
symbolTable
- is the symbolTablederivedFlag
- should be set if all dependendent derived types should also be returned.- Returns:
-
getContainedAttributes
- Returns:
- Returns the containedAttributes.
-
setContainedAttributes
- Parameters:
containedAttributes
- The containedAttributes to set.
-
getContainedElements
- Returns:
- Returns the containedElements.
-
setContainedElements
- Parameters:
containedElements
- The containedElements to set.
-