C
XDK for Java: Specifications and Cheat Sheets

Constructor

DOMParser() 

Creates a new parser object. Implements an eXtensible Markup Language (XML) 1.0 parser according to the World Wide Web Consortium (W3C) recommendation. to parse an XML document and build a DOM tree. 

Methods 

getDoctype() 

Get the DTD 

getDocument() 

Gets the document 

parseDTD(InputSource, String) 

Parses the XML External DTD from given input source 

parseDTD(InputStream, String) 

Parses the XML External DTD from given input stream. 

parseDTD(Reader, String) 

Parses the XML External DTD from given input stream. 

parseDTD(String, String) 

Parses the XML External DTD from the URL indicated 

parseDTD(URL, String) 

Parses the XML External DTD document pointed to by the given URL and creates the corresponding XML document hierarchy. 

setErrorStream(OutputStream) 

Creates an output stream for the output of errors and warnings. 

setErrorStream(OutputStream, String) 

Creates an output stream for the output of errors and warnings. 

setErrorStream(PrintWriter) 

Creates an output stream for the output of errors and warnings. 

setNodeFactory(NodeFactory) 

Set the node factory. 

showWarnings(boolean) 

Switch to determine whether to print warnings 

Class

DTD() 

Implements the DOM DocumentType interface and holds the Document Type Definition information for an XML document. 

Methods 

cloneNode(boolean) 

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. 

findElementDecl(String) 

Finds an element declaration for the given tag name. 

findEntity(String, boolean) 

Finds a named entity in the DTD. 

findNotation(String) 

Retrieves the named notation from the DTD. 

getChildNodes() 

A NodeList that contains all children of this node. 

getElementDecls() 

A NamedNodeMap containing the element declarations in the DTD. 

getEntities() 

A NamedNodeMap containing the general entities, both external and internal, declared in the DTD. 

getName() 

Gets the name of the DTD, that is, the name immediately following the DOCTYPE keyword. 

getNotations() 

A NamedNodeMap containing the notations declared in the DTD. 

getPublicId() 

Gets the public identifier associated with the DTD, if specified. 

getSystemId() 

Gets the system identifier associated with the DTD, if specified. 

hasChildNodes() 

A convenience method to allow easy determination of whether a node has any children. 

printExternalDTD(OutputStream) 

Writes the contents of this document to the given output stream. 

printExternalDTD(OutputStream, String) 

Writes the contents of the external DTD to the given output stream. 

printExternalDTD(PrintWriter) 

Writes the contents of this document to the given output stream. 

Class

ElementDecl() 

This class represents an element declaration in a DTD. 

Fields 

ANY 

Element content type - Children can be any element 

ASTERISK 

ContentModelParseTreeNode type - "*" node (has one children) 

COMMA 

ContentModelParseTreeNode type - "," node (has two children) 

ELEMENT 

ContentModelParseTreeNode type - 'leaf' node (has no children) 

ELEMENTS 

Element content type - Children can be elements as per Content Model 

EMPTY 

Element content type - No Children 

MIXED 

Element content type - Children can be PCDATA & elements as per Content Model 

OR 

ContentModelParseTreeNode type - "|" node (has two children) 

PLUS 

ContentModelParseTreeNode type - "+" node (has one children) 

QMARK 

ContentModelParseTreeNode type - "?" node (has one children) 

Methods 

expectedElements(Element) 

Returns vector of element names that can be appended to the element. 

findAttrDecl(String) 

Gets an attribute declaration object or null if not found 

getAttrDecls() 

Gets an enumeration of attribute declarations 

getContentElements() 

Returns Vector of elements that can be appended to this element 

getContentType() 

Returns content model of element 

getParseTree() 

Returns the root node of Content Model Parse Tree. 

validateContent(Element) 

Validates the content of a element node. 

Constructors 

NodeFactory() 

Specifies methods to create various nodes of the DOM tree built during parsing. Applications can override these methods to create their own custom classes to be added to the DOM tree while parsing. Applications have to register their own NodeFactory using the XMLParser's setNodeFactory() method. If a null pointer is returned by these methods, then the node will not be added to the DOM tree. 

Methods 

createAttribute(String, String) 

Creates an attribute node with the specified tag, and text. 

createCDATASection(String) 

Creates a CDATA node with the specified text. 

createComment(String) 

Creates a comment node with the specified text. 

createDocument() 

Creates a document node. 

createElement(String) 

Creates an Element node with the specified tag. 

createProcessingInstruction(String, String) 

Creates a PI node with the specified tag, and text. 

createTextNode(String) 

Creates a text node with the specified text. 

Class

NSName 

Provides Namespace support for Element and Attribute names. 

Methods 

getExpandedName() 

Gets the fully resolved name for this name 

getLocalName() 

Gets the local name for this name 

getNamespace() 

Gets the resolved Namespace for this name 

getPrefix() 

Gets the prefix for this name 

getQualifiedName() 

Gets the qualified name 

Class

NSResolver 

Provides support for resolving Namespaces. 

Methods 

resolveNamespacePrefix(String) 

Finds the namespace definition in scope for a given namespace prefix. 

Class

SAXAttrList() 

Implements the SAX AttributeList interface and also provides Namespace support. Applications that require Namespace support can explicitly cast any attribute list returned by an Oracle parser class to SAXAttrList and use the methods described here.It also implements Attributes (SAX 2.0) interface

This interface allows access to a list of attributes in three different ways:

• By attribute index;

• By Namespace-qualified name; or

• By qualified (prefixed) name.

The list will not contain attributes that were declared #IMPLIED but not specified in the start tag. It will also not contain attributes used as Namespace declarations (xmlns*) unless the http://xml.org/sax/features/namespace-prefixes feature is set to true (it is false by default).

If the namespace-prefixes feature (see above) is false, access by qualified name may not be available; if the http://xml.org/sax/features/namespaces feature is false, access by Namespace-qualified names may not be available.

This interface replaces the now-deprecated SAX1 interface, which does not contain Namespace support. In addition to Namespace support, it adds the getIndex methods (below). The order of attributes in the list is unspecified, and will vary with each implementation. 

Methods 

getExpandedName(int) 

Get the expanded name for an attribute in the list (by position) 

getLength() 

Return the number of attributes in this list. 

getLocalName(int) 

Get the local name for an attribute in the list (by position) 

getName(int) 

Return the name of an attribute in this list (by position). 

getNamespace(int) 

Get the resolved namespace for an attribute in the list (by position) 

getPrefix(int) 

Get the namespace prefix for an attribute in the list (by position) 

getQualifiedName(int) 

Get the qualified name for an attribute in the list (by position) 

/getType(int index) 

Looks up an attribute's type by index. The attribute type is one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION" (always in upper case).

If the parser has not read a declaration for the attribute, or if the parser does not report attribute types, then it must return the value "CDATA" as stated in the XML 1.0 Recommendation (clause 3.3.3, "Attribute-Value Normalization").

For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN". 

getType(java.lang.String qName) 

Looks up an attribute's type by XML 1.0 qualified name.  

getType(java.lang.String uri, java.lang.String localName) 

Looks up an attribute's type by Namespace name.  

getType(String) 

Return the type of an attribute in the list (by name). 

getValue(int) 

Return the value of an attribute in the list (by position). 

getValue(String) 

Return the value of an attribute in the list (by name). 

Class

XMLParser() 

This class serves as a base class for the DOMParser and SAXParser classes. It contains methods to parse eXtensible Markup Language (XML) 1.0 documents according to the World Wide Web Consortium (W3C) recommendation. This class can not be instantiated (applications can use the DOM or SAX parser depending on their requirements).  

Methods 

getReleaseVersion() 

Returns the release version of the Oracle XML Parser 

getValidationMode() 

Returns the validation mode 

parse(InputSource) 

Parses the XML from given input source 

parse(InputStream) 

Parses the XML from given input stream. 

parse(Reader) 

Parses the XML from given input stream. 

parse(String) 

Parses the XML from the URL indicated 

parse(URL) 

Parses the XML document pointed to by the given URL and creates the corresponding XML document hierarchy. 

setBaseURL(URL) 

Sets the base URL for loading external entities and DTDs. 

setDoctype(DTD) 

Sets the DTD 

setLocale(Locale) 

Applications can use this to set the locale for error reporting. 

setPreserveWhitespace(boolean) 

Sets the white space preserving mode 

setValidationMode(boolean) 

Sets the validation mode 

Class XMLSchema 

Sets top-level XMLSchema document declarations & definitions plus schema location and schema target namespace. XMLSchema objects are created by XSDBuilder as a result of processing XMLSchema documents. They are used by XSDParser for instance XML documents validation and by XSDBuilder as imported schemas.  

Constructors XMLSchema()

XMLSchema(int) 

Class

XDSBuilder 

Builds an XMLSchema object from XMLSchema document. XMLSchema object is a set of objects (Infoset items) corresponding to top-level schema declarations & definitions. Schema document is 'XML' parsed and converted to a DOM tree. This schema DOM tree is 'Schema' parsed in a following order: (if any) builds a schema object and makes it visible. (if any) is replaced by corresponding DOM tree. Top-level declarations & definitions are registered as a current schema infoset items. Finally, top-level tree elements (infoset items) are 'Schema' parsed. The result XMLSchema object is a set (infoset) of objects (top-level input elements). Object's contents is a tree with nodes corresponding to low-level element/group decls/refs preceded by node/object of type SNode containing cardinality info (min/maxOccurs).  

Methods build(InputStream,URL) 

Builds an XMLSchema object  

build(Reader, URL) 

Builds an XMLSchema object  

build(String) 

Builds an XMLSchema object  

build(String, String) 

Builds an XMLSchema object  

build(String, URL) 

Builds an XMLSchema object  

build(URL) 

Builds an XMLSchema object  

build(XMLDocument,URL) 

Builds XMLSchema from XML document  

getObject() 

Returns the schema object.  

setError(XMLError) 

Sets XMLError object.  

setLocale(Locale) 

Sets locale for error reporting.  

XSDException 

Indicates that an exception occurred during XMLSchema validation. 

Methods getMessage() 

Override getMessage, in order to construct error message from error id, and error params  

getMessage(XMLError) 

Get localized message based on the XMLError sent as parameter  

Classes 

CGDocument 

Serves as the base document class for the Class Generated generated classes. Constructor for the Root element of the DTD. Parameters: doctype - Name of the root Element of the DTD, dtd - The DTD used to generate the classes 

CGNode 

Serves as the base class for nodes generated by the Class Generated 

DTDClassGenerator 

Used by the Class Generator to generate classes against a DTD 

SchemaClassGenerator 

Used by the Class Generator to generate classes against a Schema 

CGXSDElement 

This class is the base class for the classes generated by Schema Class generator. The classes corresponding to the top level elements in a schema extends this class. This class contains the code for initialization and building the schema from the schema file which is required for validation purpose. Note: Since the validation is not supported, the static block for reading the schema file is not used. It should be possible to read schema file from anywhere in the scope of the CLASSPATH. It is required to read the schema file using getResource. 

Exceptions 

InvalidContentException 

Definition of InvalidContentException thrown by dtdcompiler classes 

CGDocument(String, DTD)  

Constructor for the Root element of the DTD. public abstract class CGDocument extends CGNode. Serves as the base document class for the DTD compiler generated classes 

Methods

print(OutputStream) 

Prints the constructed XML Document  

print(OutputStream, String) 

Prints the constructed XML Document 

public abstract class CGNode 

extends Object. Serves as the base class for nodes generated by the XML Class Generator.  

generate(DTD, String) 

Traverses the DTD with element doctype as root and generates Java classes 

Methods

setGenerateComments(boolean) 

Switch to determine whether to generate java doc comments. Default - TRUE  

setJavaPackage(String) 

Sets the package for the classes generated. Default - No package  

setOutputDirectory(String) 

Sets the output directory. Default - current directory  

setSerializationMode(boolean) 

Switch to determine if the DTD should be saved as a serialized object or as text file.  

setValidationMode(boolean) 

Switch to determine whether the classes generated should validate the XML Document being constructed.Default - TRUE  

CGNode(String) 

Constructor for the Elements of the DOM Tree 

Methods

addCDATASection(string) 

Adds CDATA Section to the Element. 

addData(String) 

Adds PCDATA to the Element  

addNode(CGNode) 

Adds a node as a child to the element  

getCGDocument() 

Gets the base document (root Element)  

getDTDNode() 

Gets the static DTD from the base document  

setAttribute(String, String) 

Sets the value of the Attribute  

setDocument(CGDocument) 

Sets the base document (root Element)  

storeID(String, String) 

Store this value for an ID identifier, so that we can later verify IDREF values  

storeIDREF(String, String) 

Store this value for an IDREF identifier, so that we can later verify, if an corresponding ID was defined.  

validateContent() 

Checks if the content of the element is valid as per the Content Model specified in DTD  

validEntity(String) 

Checks if the ENTITY identifier is valid  

validID(String) 

Checks if the ID identifier is valid  

validNMTOKEN(String) 

Checks if the NMTOKEN identifier is valid  

Class

CGXSDElement 

This class serves as the base class for the all the generated classes corresponding to the XML Schema generated by Schema Class Generator 

Methods 

addAttribute(String, String) 

Add the attribute of a given node to the hashtable. Parameters: attName - the attribute name, attValue - the attribute value 

addElement(Object) 

Add the elements of a given element node to the vector corresponding to the elements. Parameters: elem - the object which needs to be added 

getAttributes() 

public java.util.Hashtable getAttributes(). Return the attributes. Returns: attributes the hashtable containing attribute name and value 

getChildElements() 

public java.util.Vector getChildElements(). Get the vector having all the local elements. Returns: elemChild vector 

getNodeValue() 

public java.lang.String getNodeValue(). Return the node value 

getType() 

public java.lang.Object getType(). Return the type 

print(XMLOutputStream) 

public void print(oracle.xml.parser.v2.XMLOutputStream. out). Print an element node. Parameters: out - the stream where the output is printed 

printAttributes(XMLOutputStream, String) 

public void printAttributes(oracle.xml.parser.v2.XMLOutputStream out, java.lang.String name). Print an attribute node. Parameters: out - the stream where the output is printed, name - the attribute name 

setNodeValue(String) 

protected void setNodeValue(java.lang.String value). Set the node value of an element. Parameters: value - the node value 

-h 

Prints the help message text  

- d<dtd file> 

DTD file (.dtd file)  

- s <schema file> 

Schema file (.xsd file)  

- o <Output dirname>  

Output directory 

- c  

Comment option  

- p <package name/s> 

The package names corresponding to namespace  

Interfaces 

XSQLActionHandler 

Interface that must be implemented by all XSQL Action Element Handlers  

XSQLPageRequest 

Interface representing a request for an XSQL Page 

Classes 

XSQLActionHandlerImpl 

Base Implementation of XSQLActionHandler that can be extended to create your own custom handlers. 

XSQLCommandLine 

Command-line Utility to process XSQL Pages. 

XSQLPageRequestImpl 

Base implementation of the XSQLPageRequest interface that case be used to derive new kinds of page request implementations. 

XSQLParserHelper 

Common XML Parsing Routines 

XSQLRequest 

Programmatically process a request for an XSQL Page. 

XSQLServlet 

Servlet to enable HTTP GET-ing of and POST-ing to XSQL Pages 

XSQLServletPageRequest 

Implementation of XSQLPageRequest for Servlet-based XSQL Page requests. 

XSQLStylesheetProcessor 

XSLT Stylesheet Processing Engine 

createNestedRequest(URL, Dictionary) 

Returns an instance of a nested Request 

getConnectionName() 

Returns the name of the connection being used for this request May be null if no connection set/in-use. 

getErrorWriter() 

Returns a PrintWriter to print out errors processing this request 

getJDBCConnection() 

Gets the JDBC connection being used for this request (can be null) 

getPageEncoding() 

Returns encoding of source XSQL Page associated with this request 

getParameter(String) 

Returns the value of the requested parameter 

getPostedDocument() 

Returns the content of Posted XML for this request as an XML Document 

getRequestParamsAsXMLDocument() 

Returns the content of a Request parameters as an XML Document 

getRequestType() 

Returns a string identifying the type of page request being made. 

getSourceDocumentURI() 

Returns a String representation of the requested document's URI 

getStylesheetParameter(String) 

Gets a stylesheet parameter by name 

getStylesheetParameters() 

Gets an enumeration of stylesheet parameter names 

getStylesheetURI() 

Returns the URI of the stylesheet to be used to process the result. 

getUserAgent() 

Returns a String identifier of the requesting program 

getWriter() 

Returns a PrintWriter used for writing out the results of a page request 

getXSQLConnection() 

Gets the XSQLConnection Object being used for this request Might be null. 

isIncludedRequest() 

Returns true if this request is being included in another. 

isOracleDriver() 

Returns true if the current connection uses the Oracle JDBC Driver 

printedErrorHeader() 

Returns the state of whether an Error Header has been printed 

requestProcessed() 

Allows Page Request to Perform end-of-request processing 

setConnectionName(String) 

Sets the connection name to use for this request 

setContentType(String) 

Sets the content type of the resulting page 

setIncludingRequest(XSQLPageRequest) 

Sets the Including Page Request object for this request. 

setPageEncoding(String) 

Sets encoding of source XSQL page associated with this request. 

setPageParam(String, String) 

Sets a dynamic page parameter value. 

setPostedDocument(Document) 

Allows programmatic setting of the Posted Document 

setPrintedErrorHeader(boolean) 

Sets whether an Error Header has been printed 

setStylesheetParameter(String, String) 

Sets the value of a parameter to be passed to the associated stylesheet 

setStylesheetURI(String) 

Sets the URI of the stylesheet to be used to process the result. 

translateURL(String) 

Returns a string representing an absolute URL resolved relative to the base URI for this request. 

useConnectionPooling() 

Returns true if connection pooling is desired for this request 

useHTMLErrors() 

Returns true if HTML-formatted error messages are desired for this request