org.apache.axis.wsdl.symbolTable

Class SchemaUtils


public class SchemaUtils
extends java.lang.Object

This class contains static utility methods specifically for schema type queries.
Author:
Rich Scheuerle (scheu@us.ibm.com)

Method Summary

static String
getAnnotationDocumentation(Node typeNode)
Returns the complete text of the child xsd:annotation/xsd:documentation element from the provided node.
static QName
getArrayComponentQName(Node node, IntHolder dims, BooleanHolder underlTypeNillable, QNameHolder itemQName, BooleanHolder forElement, SymbolTable symbolTable)
If the specified node represents an array encoding of one of the following forms, then return the qname repesenting the element type of the array.
static QName
getAttributeAnonQName(Node node)
Returns the WSDL2Java QName for the anonymous type of the attribute or null.
static TypeEntry
getBaseType(TypeEntry type, SymbolTable symbolTable)
Returns the base type of a given type with its symbol table.
static QName
getCollectionComponentQName(Node node, QNameHolder itemQName, BooleanHolder forElement, SymbolTable symbolTable)
If the specified node represents an element that references a collection then return the qname repesenting the component of the collection.
static TypeEntry
getComplexElementExtensionBase(Node node, SymbolTable symbolTable)
If the specified node represents a supported JAX-RPC complexType/element which extends another complexType.
static TypeEntry
getComplexElementRestrictionBase(Node node, SymbolTable symbolTable)
Look for the base type of node iff node is a complex type that has been derived by restriction; otherwise return null.
static Vector
getContainedAttributeTypes(Node node, SymbolTable symbolTable)
Return the attribute names and types if any in the node The even indices are the attribute types (TypeEntry) and the odd indices are the corresponding names (Strings).
static Vector
getContainedElementDeclarations(Node node, SymbolTable symbolTable)
If the specified node represents a supported JAX-RPC complexType or simpleType, a Vector is returned which contains ElementDecls for the child element names.
static QName[]
getContainedSimpleTypes(Node node)
Method getContainedSimpleTypes
static QName
getElementAnonQName(Node node)
Returns the WSDL2Java QName for the anonymous type of the element or null.
static QName
getListItemType(Node node)
Returns the value of itemType attribute of in
static Node
getListNode(Node node)
static Node
getRestrictionOrExtensionNode(Node node)
Returns the contained restriction or extension node underneath the specified node.
static QName
getSimpleTypeBase(Node node)
If the specified node represents a 'normal' non-enumeration simpleType, the QName of the simpleType base is returned.
static String
getTextByPath(Node root, String path)
Returns all textual nodes of a subnode defined by a parent node and a path of element names to that subnode.
static Node
getUnionNode(Node node)
static boolean
isListWithItemType(Node node)
Returns whether the specified node represents a with a nested .
static boolean
isMixed(Node node)
This method checks mixed=true attribute is set either on complexType or complexContent element.
static boolean
isSimpleSchemaType(QName qname)
Determine if a QName is a simple XML Schema type
static boolean
isSimpleTypeOrSimpleContent(Node node)
If the specified node is a simple type or contains simpleContent, return true
static boolean
isSimpleTypeWithUnion(Node node)
static boolean
isWrappedType(Node node)
This method checks out if the given node satisfies the 3rd condition of the "wrapper" style: such an element (a wrapper) must be of a complex type defined using the xsd:sequence compositor and containing only elements declarations.

Method Details

getAnnotationDocumentation

public static String getAnnotationDocumentation(Node typeNode)
Returns the complete text of the child xsd:annotation/xsd:documentation element from the provided node. Only the first annotation element and the first documentation element in the annotation element will be used.
Parameters:
typeNode - Parent node.

getArrayComponentQName

public static QName getArrayComponentQName(Node node,
                                           IntHolder dims,
                                           BooleanHolder underlTypeNillable,
                                           QNameHolder itemQName,
                                           BooleanHolder forElement,
                                           SymbolTable symbolTable)
If the specified node represents an array encoding of one of the following forms, then return the qname repesenting the element type of the array.
Parameters:
node - is the node
dims - is the output value that contains the number of dimensions if return is not null
itemQName - will end up containing the "inner" QName for a wrapped literal array
Returns:
QName or null

getAttributeAnonQName

public static QName getAttributeAnonQName(Node node)
Returns the WSDL2Java QName for the anonymous type of the attribute or null.
Parameters:
node -
Returns:

getBaseType

public static TypeEntry getBaseType(TypeEntry type,
                                    SymbolTable symbolTable)
Returns the base type of a given type with its symbol table. This logic is extracted from JavaTypeWriter's constructor() method for reusing.
Parameters:
type -
symbolTable -
Returns:

getCollectionComponentQName

public static QName getCollectionComponentQName(Node node,
                                                QNameHolder itemQName,
                                                BooleanHolder forElement,
                                                SymbolTable symbolTable)
If the specified node represents an element that references a collection then return the qname repesenting the component of the collection.

returns qname for"xsd:string"

returns qname for"xsd:string"

returns qname for "alias"

Parameters:
node - is the Node
Returns:
QName of the compoent of the collection

getComplexElementExtensionBase

public static TypeEntry getComplexElementExtensionBase(Node node,
                                                       SymbolTable symbolTable)
If the specified node represents a supported JAX-RPC complexType/element which extends another complexType. The Type of the base is returned.
Parameters:
node -
symbolTable -
Returns:

getComplexElementRestrictionBase

public static TypeEntry getComplexElementRestrictionBase(Node node,
                                                         SymbolTable symbolTable)
Look for the base type of node iff node is a complex type that has been derived by restriction; otherwise return null.
Parameters:
node -
symbolTable -
Returns:

getContainedAttributeTypes

public static Vector getContainedAttributeTypes(Node node,
                                                SymbolTable symbolTable)
Return the attribute names and types if any in the node The even indices are the attribute types (TypeEntry) and the odd indices are the corresponding names (Strings).

Example:

Parameters:
node -
symbolTable -
Returns:

getContainedElementDeclarations

public static Vector getContainedElementDeclarations(Node node,
                                                     SymbolTable symbolTable)
If the specified node represents a supported JAX-RPC complexType or simpleType, a Vector is returned which contains ElementDecls for the child element names. If the element is a simpleType, an ElementDecls is built representing the restricted type with the special name "value". If the element is a complexType which has simpleContent, an ElementDecl is built representing the extended type with the special name "value". This method does not return attribute names and types (use the getContainedAttributeTypes) If the specified node is not a supported JAX-RPC complexType/simpleType/element null is returned.
Parameters:
node -
symbolTable -
Returns:

getContainedSimpleTypes

public static QName[] getContainedSimpleTypes(Node node)
Method getContainedSimpleTypes
Parameters:
node -
Returns:

getElementAnonQName

public static QName getElementAnonQName(Node node)
Returns the WSDL2Java QName for the anonymous type of the element or null.
Parameters:
node -
Returns:

getListItemType

public static QName getListItemType(Node node)
Returns the value of itemType attribute of in
Parameters:
node -
Returns:

getListNode

public static Node getListNode(Node node)

getRestrictionOrExtensionNode

public static Node getRestrictionOrExtensionNode(Node node)
Returns the contained restriction or extension node underneath the specified node. Returns null if not found
Parameters:
node -
Returns:

getSimpleTypeBase

public static QName getSimpleTypeBase(Node node)
If the specified node represents a 'normal' non-enumeration simpleType, the QName of the simpleType base is returned.
Parameters:
node -
Returns:

getTextByPath

public static String getTextByPath(Node root,
                                   String path)
            throws DOMException
Returns all textual nodes of a subnode defined by a parent node and a path of element names to that subnode.
Parameters:
root - Parent node.
path - Path of element names to text of interest, delimited by "/".

getUnionNode

public static Node getUnionNode(Node node)

isListWithItemType

public static boolean isListWithItemType(Node node)
Returns whether the specified node represents a with a nested .
Parameters:
node -
Returns:

isMixed

public static boolean isMixed(Node node)
This method checks mixed=true attribute is set either on complexType or complexContent element.

isSimpleSchemaType

public static boolean isSimpleSchemaType(QName qname)
Determine if a QName is a simple XML Schema type
Parameters:
qname -
Returns:

isSimpleTypeOrSimpleContent

public static boolean isSimpleTypeOrSimpleContent(Node node)
If the specified node is a simple type or contains simpleContent, return true
Parameters:
node -
Returns:

isSimpleTypeWithUnion

public static boolean isSimpleTypeWithUnion(Node node)

isWrappedType

public static boolean isWrappedType(Node node)
This method checks out if the given node satisfies the 3rd condition of the "wrapper" style: such an element (a wrapper) must be of a complex type defined using the xsd:sequence compositor and containing only elements declarations. (excerpt from JAX-RPC spec 1.1 Maintenanace Review 2 Chapter 6 Section 4.1.)
Parameters:
node -
Returns:

Copyright © 2005 Apache Web Services Project. All Rights Reserved.