org.netbeans.modules.schema2beansdev

Class SchemaRep

java.lang.Object

org.netbeans.modules.schema2beansdev.SchemaRep

All Implemented Interfaces:

PrefixGuesser

public class SchemaRep
extends Object
implements PrefixGuesser

This class will represent a schema for XML as a Java object. (This implementation isn't complete, but does enough for my purposes for now.)

Author:

cliffwd

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SchemaRep.All
class	SchemaRep.Annotation
class	SchemaRep.Any
class	SchemaRep.AnyAttribute
class	SchemaRep.AnyNode
class	SchemaRep.AppInfo
class	SchemaRep.Attribute
class	SchemaRep.AttributeGroup
class	SchemaRep.Base64Binary
static interface	SchemaRep.CanRef
class	SchemaRep.Choice
class	SchemaRep.ComplexContent
class	SchemaRep.ComplexType
class	SchemaRep.ContainsSubElements
class	SchemaRep.Documentation
class	SchemaRep.Element
class	SchemaRep.ElementExpr
class	SchemaRep.ElementInformationItem
static interface	SchemaRep.EncodingStyle
class	SchemaRep.Enumeration
class	SchemaRep.Extension
class	SchemaRep.Field
class	SchemaRep.FractionDigits
class	SchemaRep.Group
static interface	SchemaRep.HasJavaTypeName
class	SchemaRep.HasTypeName
class	SchemaRep.HexBinary
class	SchemaRep.Import
class	SchemaRep.Include
class	SchemaRep.Key
class	SchemaRep.KeyRef
class	SchemaRep.Length
class	SchemaRep.ListElement
class	SchemaRep.MaxExclusive
class	SchemaRep.MaxInclusive
class	SchemaRep.MaxLength
class	SchemaRep.MinExclusive
class	SchemaRep.MinInclusive
class	SchemaRep.MinLength
static interface	SchemaRep.MinMaxOccurs
class	SchemaRep.ModelGroup
class	SchemaRep.Pattern
class	SchemaRep.Restriction
class	SchemaRep.RestrictionType
class	SchemaRep.SchemaNode
class	SchemaRep.Selector
class	SchemaRep.SelectorOrField
class	SchemaRep.Sequence
class	SchemaRep.SimpleContent
class	SchemaRep.SimpleType
class	SchemaRep.TextNode
class	SchemaRep.TotalDigits
class	SchemaRep.UnionType
class	SchemaRep.Unique
class	SchemaRep.WhiteSpace

Field Summary

Fields

Modifier and Type	Field and Description
protected Stack	currentElementStack
static boolean	debug
protected Map	definedAttributes
protected Map	definedTypes
protected Map	definedTypesFull
protected String	documentNamespace
protected Map	elementTable
protected Map	includedAlready
protected SchemaRep.ElementExpr	lastPopped
protected Map	namespaceTable
protected Map	optionallyDefinedTypes
protected Map	predefinedSchemaTypes
protected Map	requiredPredefinedTypes
protected SchemaRep.ContainsSubElements	rootElement
protected Map	sampleNodes
protected String	targetNamespace
protected SchemaRep.Annotation	topAnnotation
static String	XSD_NS

Constructor Summary

Constructors

Constructor and Description
SchemaRep()
SchemaRep(Document schemaDoc, String uri)
SchemaRep(Document schemaDoc, String uri, boolean useBigDataTypes)

Method Summary

Modifier and Type	Method and Description
void	addAppInfo(String name, String value) Create AppInfo and add it to the current thing in the stack.
void	addAppInfoToTopAnnotation(String name, String value)
void	addElement(String name, String type) Create an Element an add it to the current one in the stack.
protected void	addRestriction(SchemaRep.ContainsSubElements cse, String restrictionBase, SchemaRep.RestrictionType... rt)
void	addSubElement(String elementName, List subElements)
void	addSubElement(String elementName, SchemaRep.ElementExpr subElement)
void	addSubElement(String elementName, String subElementName)
void	addSubElementCurrent(String subElementName) This addSubElement creates an Element and then adds it underneath the current one.
void	addToNamespace(String ns, String URI) Example: ns=xsd, URI=http://www.w3.org/2001/XMLSchema
void	addToTopAnnotation(SchemaRep.ElementExpr subElement)
static String	canonicalQName(String namespaceURI, String localPart)
SchemaRep.Element	createElement(String name) Return an Element that represents an ELEMENT.
SchemaRep.Element	createElement(String name, String type) Return an Element that represents an ELEMENT.
List	findAllSubElements(String name)
Set	getAllNamespaces()
SchemaRep.Attribute	getAttribute(String name)
protected String	getCurrentParsedURI()
SchemaRep.Element	getDefinedElement(String typeName)
Set	getDefinedElementNames()
SchemaRep.Element	getDefinedElementResolvedNamespace(String typeName)
SchemaRep.ElementExpr	getLastPopped()
String	getNamespace(String URI) Return a namespace name for a given namespace URI.
String	getNamespaceURI(String ns) Return the namespace URI for a given namespace prefix.
SchemaRep.ContainsSubElements	getRootElement()
protected SchemaRep.ElementExpr	getSampleNode(String name)
SchemaRep.ElementExpr	getSchemaTypeDef(String origTypeName) Get an ElementExpr node for a named type.
SchemaRep.ElementExpr	getSchemaTypeDefResolvedNamespace(String typeName) Same thing as getSchemaTypeDef, but for already resolved type names.
Set	getSchemaTypeNames()
String	getTargetNamespace()
String	getXMLNamespace()
static String	getXPathExpr(Node node)
static String	getXPathExpr(Node node, boolean addDescription)
String	getXSDNamespace()
static String	guessPrefix(String namespaceURI) Guess what a prefix of this namespaceURI might be.
String	guessPrefixFromURI(String uri) Try to figure out what prefix to use for the namespaceURI using the namespace context mapping, and if that fails then it calls guessPrefix.
boolean	isDefinedType(String type)
boolean	isPredefinedType(String type)
String	javaType2XMLSchemaTypeComplex(String type)
void	mapSimpleJavaTypesOptional(Map optionalElementMap) Map simple types to our schema.
void	mapSimpleJavaTypesPredefined(Map definedElementMap) Map simple types to our schema.
protected String	normalizeDocumentNamespace(String type)
protected String	normalizeNamespace(String namespaceURI, String localPart) return prefix ':' localPart eg: namespaceURI="http://www.w3.org/XML/1998/namespace" localPart="id" -> "xml:id" eg: namespaceURI="" localPart="foo" -> "foo" eg: namespaceURI=null localPart="bar" -> "bar"
protected String	normalizeTargetNamespace(String type) Will add a namespace prefix to a type if the targetNamespace != null.
SchemaRep.ElementExpr	optimize() This is called before writing out a schema.
SchemaRep.ElementExpr	peekCurrent()
SchemaRep.ContainsSubElements	peekCurrentNeedSub() Same thing as peekCurrent, but the caller needs it to be a ContainsSubElements.
SchemaRep.ElementExpr	popCurrent()
static String	prefixOf(String typeName) eg: 'xsd:element' -> 'xsd'
static void	printExtraJavaTypes(Writer out, int level) Define some helpful java to XML Schema data types that allow us to go back and forth between the two (allows me to setup a 1-to-1 mapping with the client proxy generator).
void	pushComplexType()
void	pushCurrent(SchemaRep.ElementExpr el)
void	pushElement(String elementName, String elementType) Create the element, then push it onto the stack, making it the current one.
void	pushSchemaNode()
void	pushSequence()
protected void	putSampleNode(SchemaRep.ElementExpr ee)
void	putSchemaTypeDef(String typeName, SchemaRep.ElementExpr ee)
protected void	read(Node node)
void	readDocument(Document doc)
void	readSchemaElement(Element el, boolean include)
void	readSchemaFromLocation(String schemaLocation, boolean include)
static String	removePrefix(String typeName)
String	resolveNamespace(String typeName) Will convert a typeName into {namespace}typeName format.
String	resolveNamespace(String ns, String type)
protected String	resolveNamespaceDefault(String typeName, String defaultNS)
protected String	resolveNamespaceDefault(String prefix, String defaultNS, String type)
String	schemaTypeToJavaType(String xmlSchemaType)
void	setCurrentParsedURI(String uri)
void	setMaxOccurs(String t) Only works if the current thing in the stack is an Element or ModelGroup.
void	setMinOccurs(String t) Only works if the current thing in the stack is an Element or ModelGroup.
void	setRootElement(SchemaRep.ContainsSubElements el)
void	setSchemaTypeMapping(String schemaTypeNamespace, String schemaTypeName, String javaType)
void	setSchemaTypesForME(boolean isFloatingPoint) Setup the schema to java type mapping to make more sense for J2ME.
void	setTargetNamespace(String ns)
void	setType(String t) Only works if the current thing in the stack is an Element.
void	setXMLSchemaType(String t) Only works if the current thing in the stack is an Element.
void	writeDTD(Writer out) If you want a DTD written to a Writer, this is the method to call.
void	writeXMLSchema(XMLWriter out)
void	writeXMLSchemaStandalone(Writer out) If you want an XML Schema written to a Writer, this is the method to call.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

debug

public static boolean debug

XSD_NS

public static final String XSD_NS

See Also:

Constant Field Values

namespaceTable

protected Map namespaceTable

targetNamespace

protected String targetNamespace

documentNamespace

protected String documentNamespace

rootElement

protected SchemaRep.ContainsSubElements rootElement

elementTable

protected Map elementTable

optionallyDefinedTypes

protected Map optionallyDefinedTypes

definedTypes

protected Map definedTypes

definedTypesFull

protected Map definedTypesFull

definedAttributes

protected Map definedAttributes

predefinedSchemaTypes

protected Map predefinedSchemaTypes

requiredPredefinedTypes

protected Map requiredPredefinedTypes

currentElementStack

protected Stack currentElementStack

topAnnotation

protected SchemaRep.Annotation topAnnotation

lastPopped

protected SchemaRep.ElementExpr lastPopped

sampleNodes

protected Map sampleNodes

includedAlready

protected Map includedAlready

Constructor Detail

SchemaRep

public SchemaRep()

SchemaRep

public SchemaRep(Document schemaDoc,
                 String uri)

SchemaRep

public SchemaRep(Document schemaDoc,
                 String uri,
                 boolean useBigDataTypes)

Method Detail

addToNamespace

public void addToNamespace(String ns,
                           String URI)

Example: ns=xsd, URI=http://www.w3.org/2001/XMLSchema

getNamespaceURI

public String getNamespaceURI(String ns)

Return the namespace URI for a given namespace prefix. Will return null if the namespace URI is unheard of. Example: ns="xsd", returns "http://www.w3.org/2001/XMLSchema"

getNamespace

public String getNamespace(String URI)

Return a namespace name for a given namespace URI. One will be made up, if it doesn't already exist. Example: URI="http://www.w3.org/2001/XMLSchema", returns "xsd"

getAllNamespaces

public Set getAllNamespaces()

Returns:

the Set of all namespace prefixes in use.

getXSDNamespace

public String getXSDNamespace()

getXMLNamespace

public String getXMLNamespace()

getAttribute

public SchemaRep.Attribute getAttribute(String name)

putSampleNode

protected void putSampleNode(SchemaRep.ElementExpr ee)

getSampleNode

protected SchemaRep.ElementExpr getSampleNode(String name)

setTargetNamespace

public void setTargetNamespace(String ns)

getTargetNamespace

public String getTargetNamespace()

setCurrentParsedURI

public void setCurrentParsedURI(String uri)

getCurrentParsedURI

protected String getCurrentParsedURI()

setRootElement

public void setRootElement(SchemaRep.ContainsSubElements el)

getRootElement

public SchemaRep.ContainsSubElements getRootElement()

addToTopAnnotation

public void addToTopAnnotation(SchemaRep.ElementExpr subElement)

addAppInfoToTopAnnotation

public void addAppInfoToTopAnnotation(String name,
                                      String value)

pushCurrent

public void pushCurrent(SchemaRep.ElementExpr el)

pushElement

public void pushElement(String elementName,
                        String elementType)

Create the element, then push it onto the stack, making it the current one.

pushSchemaNode

public void pushSchemaNode()

pushComplexType

public void pushComplexType()

pushSequence

public void pushSequence()

popCurrent

public SchemaRep.ElementExpr popCurrent()

peekCurrent

public SchemaRep.ElementExpr peekCurrent()

peekCurrentNeedSub

public SchemaRep.ContainsSubElements peekCurrentNeedSub()

Same thing as peekCurrent, but the caller needs it to be a ContainsSubElements. If it isn't an exception is thrown.

getLastPopped

public SchemaRep.ElementExpr getLastPopped()

addElement

public void addElement(String name,
                       String type)

Create an Element an add it to the current one in the stack.

addAppInfo

public void addAppInfo(String name,
                       String value)

Create AppInfo and add it to the current thing in the stack.

setType

public void setType(String t)

Only works if the current thing in the stack is an Element.

findAllSubElements

public List findAllSubElements(String name)

setXMLSchemaType

public void setXMLSchemaType(String t)

Only works if the current thing in the stack is an Element.

setMinOccurs

public void setMinOccurs(String t)

Only works if the current thing in the stack is an Element or ModelGroup.

setMaxOccurs

public void setMaxOccurs(String t)

Only works if the current thing in the stack is an Element or ModelGroup.

createElement

public SchemaRep.Element createElement(String name)

Return an Element that represents an ELEMENT.

createElement

public SchemaRep.Element createElement(String name,
                                       String type)

Return an Element that represents an ELEMENT.

addSubElement

public void addSubElement(String elementName,
                          SchemaRep.ElementExpr subElement)

addSubElement

public void addSubElement(String elementName,
                          List subElements)

addSubElement

public void addSubElement(String elementName,
                          String subElementName)

addSubElementCurrent

public void addSubElementCurrent(String subElementName)

This addSubElement creates an Element and then adds it underneath the current one.

optimize

public SchemaRep.ElementExpr optimize()

This is called before writing out a schema.

writeDTD

public void writeDTD(Writer out)
              throws IOException

If you want a DTD written to a Writer, this is the method to call.

Throws:

IOException

writeXMLSchemaStandalone

public void writeXMLSchemaStandalone(Writer out)
                              throws IOException

If you want an XML Schema written to a Writer, this is the method to call.

Throws:

IOException

writeXMLSchema

public void writeXMLSchema(XMLWriter out)
                    throws IOException

Throws:

IOException

readSchemaFromLocation

public void readSchemaFromLocation(String schemaLocation,
                                   boolean include)
                            throws IOException,
                                   SAXException

Throws:

IOException

SAXException

readDocument

public void readDocument(Document doc)

readSchemaElement

public void readSchemaElement(Element el,
                              boolean include)

read

protected void read(Node node)

getXPathExpr

public static String getXPathExpr(Node node)

getXPathExpr

public static String getXPathExpr(Node node,
                                  boolean addDescription)

schemaTypeToJavaType

public String schemaTypeToJavaType(String xmlSchemaType)

getSchemaTypeDef

public SchemaRep.ElementExpr getSchemaTypeDef(String origTypeName)

Get an ElementExpr node for a named type. null is an acceptable return value if not found. If @param typeName is null, null is returned. If @param typeName's namespace is not set, then we first check the documentNamespace, then the targetNamespace.

getSchemaTypeDefResolvedNamespace

public SchemaRep.ElementExpr getSchemaTypeDefResolvedNamespace(String typeName)

Same thing as getSchemaTypeDef, but for already resolved type names.

getSchemaTypeNames

public Set getSchemaTypeNames()

Returns:

the Set of all defined element names in a format that can be passed to getSchemaTypeDefResolvedNamespace.

getDefinedElement

public SchemaRep.Element getDefinedElement(String typeName)

getDefinedElementResolvedNamespace

public SchemaRep.Element getDefinedElementResolvedNamespace(String typeName)

Parameters:

typeName - is the resolved type name "{http://foo}login"

Returns:

the Element which defines it, or null if not found.

getDefinedElementNames

public Set getDefinedElementNames()

Returns:

the Set of all defined element names in a format that can be passed to getDefinedElementResolvedNamespace.

putSchemaTypeDef

public void putSchemaTypeDef(String typeName,
                             SchemaRep.ElementExpr ee)

resolveNamespace

public String resolveNamespace(String typeName)

Will convert a typeName into {namespace}typeName format. eg: 'xsd:string' -> '{http://www.w3.org/2001/XMLSchema}string' eg: 'item' -> 'item'

resolveNamespaceDefault

protected String resolveNamespaceDefault(String typeName,
                                         String defaultNS)

resolveNamespace

public String resolveNamespace(String ns,
                               String type)

resolveNamespaceDefault

protected String resolveNamespaceDefault(String prefix,
                                         String defaultNS,
                                         String type)

canonicalQName

public static String canonicalQName(String namespaceURI,
                                    String localPart)

normalizeTargetNamespace

protected String normalizeTargetNamespace(String type)

Will add a namespace prefix to a type if the targetNamespace != null. eg: targetNamespace='j2ee' type='ejbType' -> 'j2ee:ejbType' eg: targetNamespace='j2ee' type='xsd:string' -> 'xsd:string' eg: targetNamespace=null type='item' -> 'item'

normalizeNamespace

protected String normalizeNamespace(String namespaceURI,
                                    String localPart)

return prefix ':' localPart eg: namespaceURI="http://www.w3.org/XML/1998/namespace" localPart="id" -> "xml:id" eg: namespaceURI="" localPart="foo" -> "foo" eg: namespaceURI=null localPart="bar" -> "bar"

normalizeDocumentNamespace

protected String normalizeDocumentNamespace(String type)

setSchemaTypeMapping

public void setSchemaTypeMapping(String schemaTypeNamespace,
                                 String schemaTypeName,
                                 String javaType)

Parameters:

schemaTypeName - The name of a leaf schema element, like 'integer'.

javaType - The java class schemaTypeName gets mapped to, like 'int'.

setSchemaTypesForME

public void setSchemaTypesForME(boolean isFloatingPoint)

Setup the schema to java type mapping to make more sense for J2ME.

addRestriction

protected void addRestriction(SchemaRep.ContainsSubElements cse,
                              String restrictionBase,
                              SchemaRep.RestrictionType... rt)

mapSimpleJavaTypesOptional

public void mapSimpleJavaTypesOptional(Map optionalElementMap)

Map simple types to our schema.

mapSimpleJavaTypesPredefined

public void mapSimpleJavaTypesPredefined(Map definedElementMap)

Map simple types to our schema.

printExtraJavaTypes

public static void printExtraJavaTypes(Writer out,
                                       int level)
                                throws IOException

Define some helpful java to XML Schema data types that allow us to go back and forth between the two (allows me to setup a 1-to-1 mapping with the client proxy generator).

Throws:

IOException

javaType2XMLSchemaTypeComplex

public String javaType2XMLSchemaTypeComplex(String type)

isDefinedType

public boolean isDefinedType(String type)

isPredefinedType

public boolean isPredefinedType(String type)

removePrefix

public static String removePrefix(String typeName)

prefixOf

public static String prefixOf(String typeName)

eg: 'xsd:element' -> 'xsd'

guessPrefix

public static String guessPrefix(String namespaceURI)

Guess what a prefix of this namespaceURI might be.

guessPrefixFromURI

public String guessPrefixFromURI(String uri)

Try to figure out what prefix to use for the namespaceURI using the namespace context mapping, and if that fails then it calls guessPrefix.

Specified by:

guessPrefixFromURI in interface PrefixGuesser