cl.utfsm.acs.xml

Class CommonSchema

java.lang.Object

cl.utfsm.acs.xml.CommonSchema

Direct Known Subclasses:

ErrorSchema

public class CommonSchema
extends java.lang.Object

The common schema reads the COMMON_TYPES schema file, and setup general types definitions. The main purpose of this class is to have the information of the schema files centralized in a schema class. This object automatically parse the schema file and save all the simple and complex types into an internal Arraylist.

Author:

Mauricio Araya (maray[at]inf.utfsm.cl)

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	COMMON_TYPES The common types schema filename
protected org.w3c.dom.Document	commonTypes The DOM Document object.
protected DOMParser	parser The local DOM parser reference
protected java.util.ArrayList<AcsType>	typeList The list of types on the schema

Constructor Summary

Constructors

Constructor and Description
CommonSchema() Parse the schema file and initialize the class.

Method Summary

Modifier and Type	Method and Description
AcsType	getType(java.lang.String name) Get a type (simple or complex) by name.
AcsAttribute	readAttribute(org.w3c.dom.Node one) Read a DOM attribute node and return a new AcsAttribute object
java.lang.String	readDocumentation(org.w3c.dom.Node anno) Read a DOM annotation node with documentation, and return the string documentation.
void	searchComplexTypes(org.w3c.dom.Document doc, java.lang.String namespace) Search for ComplexTypes in the parsed document and add them to the Arraylist.
void	searchSimpleTypes(org.w3c.dom.Document doc, java.lang.String namespace) Search for SimpleTypes in the parsed document and add them to the Arraylist.

Methods inherited from class java.lang.Object

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

Field Detail

COMMON_TYPES

protected static java.lang.String COMMON_TYPES

The common types schema filename

parser

protected DOMParser parser

The local DOM parser reference

commonTypes

protected org.w3c.dom.Document commonTypes

The DOM Document object.

typeList

protected java.util.ArrayList<AcsType> typeList

The list of types on the schema

Constructor Detail

CommonSchema

public CommonSchema()

Parse the schema file and initialize the class. Also adds basic types from the classic schema definition.

TODO: add all the classic schema definitions

Method Detail

searchSimpleTypes

public void searchSimpleTypes(org.w3c.dom.Document doc,
                              java.lang.String namespace)

Search for SimpleTypes in the parsed document and add them to the Arraylist.

Parameters:

doc - The DOM document to search

namespace - The namespace that those types should have

readAttribute

public AcsAttribute readAttribute(org.w3c.dom.Node one)

Read a DOM attribute node and return a new AcsAttribute object

Parameters:

node - the DOM attribute node

Returns:

A new AcsAttribute object from the node

readDocumentation

public java.lang.String readDocumentation(org.w3c.dom.Node anno)

Read a DOM annotation node with documentation, and return the string documentation.

Parameters:

anno - the DOM node

Returns:

The String with the documentation

searchComplexTypes

public void searchComplexTypes(org.w3c.dom.Document doc,
                               java.lang.String namespace)

Search for ComplexTypes in the parsed document and add them to the Arraylist. This class is unstable, and untested. I asure that works with the commontypes file only.

Parameters:

doc - The DOM document to search

namespace - The namespace that those types should have

getType

public AcsType getType(java.lang.String name)

Get a type (simple or complex) by name.

Parameters:

name - the name of the type

Returns:

the type, or null if not found.