com.goldencode.p2j.xml

Class XDocumentImpl

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

com.goldencode.p2j.xml.XCommonImpl

com.goldencode.p2j.xml.XEntityImpl

com.goldencode.p2j.xml.XDocumentImpl

All Implemented Interfaces:

CommonHandle, CommonHandleChain, Deletable, InstantiatingProcedure, Nameable, NamespaceURI, SubTypeAttribute, UniqueID, WrappedResource, Encoding, XCommon, XDocument, XEntity, XmlSchema, Printable

public class XDocumentImpl
extends XEntityImpl
implements XDocument

Implementation of the X-Document specific features of the Progress DOM XML support objects.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	isSuppressNamespaceProcessing The flag to maintain suppress namespace processing.
private java.lang.String	noNamespaceSchemaLocation The value of the NONAMESPACE-SCHEMA-LOCATION attribute.
private java.util.Map<java.lang.String,java.lang.String>	schemaLocations The added schema locations, per namespace URI.
private java.lang.String	schemaPaths Schema paths locations variable
private org.w3c.dom.Document	xdoc The real document to assign with handle.

Fields inherited from class com.goldencode.p2j.xml.XEntityImpl

IS_INVALID_NODE

Fields inherited from class com.goldencode.p2j.xml.XCommonImpl

isValid

Fields inherited from class com.goldencode.p2j.util.HandleChain

name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource

instProc, pm

Constructor Summary

Constructors

Constructor and Description
XDocumentImpl() Default constructor.
XDocumentImpl(org.w3c.dom.Document xdoc) Associate this X-DOCUMENT resource with an existing document

Method Summary

Modifier and Type	Method and Description
java.lang.String	_name() Get the name attribute of handle as a string.
logical	addSchemaLocation(character namespace, character location) Adding new match pair for namespace schema and physical file location.
private javax.xml.validation.Schema	buildSchema() Build the validation schema using the noNamespaceSchemaLocation, schemaPaths and addSchemaLocation(com.goldencode.p2j.util.character, com.goldencode.p2j.util.character) values.
logical	createNode(handle hChild, character name, character type) Creating the new node within the current Document object.
logical	createNode(handle hChild, character name, java.lang.String type) Creating the new node within the current Document object.
logical	createNode(handle hChild, java.lang.String name, character type) Creating the new node within the current Document object.
logical	createNode(handle hChild, java.lang.String name, java.lang.String type) Creating the new node within the current Document object.
logical	createNodeNamespace(handle hChild, character uri, character name, character type) Creating the new node within the current Document object using different approach based on the name space URI.
logical	createNodeNamespace(handle hChild, character uri, character name, java.lang.String type) Creating the new node within the current Document object using different approach based on the name space URI.
logical	createNodeNamespace(handle hChild, character uri, java.lang.String name, character type) Creating the new node within the current Document object using different approach based on the name space URI.
logical	createNodeNamespace(handle hChild, character uri, java.lang.String name, java.lang.String type) Creating the new node within the current Document object using different approach based on the name space URI.
logical	createNodeNamespace(handle hChild, java.lang.String uri, character name, character type) Creating the new node within the current Document object using different approach based on the name space URI.
logical	createNodeNamespace(handle hChild, java.lang.String uri, character name, java.lang.String type) Creating the new node within the current Document object using different approach based on the name space URI.
logical	createNodeNamespace(handle hChild, java.lang.String uri, java.lang.String name, character type) Creating the new node within the current Document object using different approach based on the name space URI.
logical	createNodeNamespace(handle hChild, java.lang.String uri, java.lang.String name, java.lang.String type) Creating the new node within the current Document object using different approach based on the name space URI.
integer	getChildNum() Gets the number of child for the current one.
logical	getDocumentElement(handle hRoot) Getting the root node for the current document.
character	getEncoding() Get encoding
integer	getEntityExpansionLimit() Get the entity expansion limit.
org.w3c.dom.Node	getNode() Getting the Element backend object for this XEntity.
character	getNonamespaceSchemaLocation() Gets the value of the XML schema file for elements with no namespaces.
handle	getOwnerDocument() Getting the Document the current reference belongs to.
character	getPublicId() This method returns the public ID of the external DTD from which an XML document was generated.
character	getSchemaLocation() Determines the list of namespace/location pairs of an XML Schema file to validate against.
character	getSchemaPath() A delimiter-separated list of directory paths used to locate the XML Document Type Definition (DTD) associated with a particular XML document.
logical	getStrictEntityResolution() Indicates if the strict entity resolution is enabled.
logical	getSuppressNamespaceProcessing() Indicates if the namespace processing is suppressed or not.
character	getSystemId() Returns the system ID of the external DTD from which an XML document was generated.
logical	importNode(handle xNodeRef, handle xSourceNodeRef, boolean deep) Creating the new node within the current Document object.
logical	importNode(handle xNodeRef, handle xSourceNodeRef, logical deep) Creating the new node within the current Document object.
logical	initializeDocumentType(character namespaceUri, character rootNodeName, character publicId, character systemId) Creates a new XML document, initializes the document based on the referenced DTD, and creates its root node.
logical	initializeDocumentType(character namespaceUri, java.lang.String rootNodeName, character publicId, character systemId) Creates a new XML document, initializes the document based on the referenced DTD, and creates its root node.
logical	initializeDocumentType(java.lang.String namespaceUri, character rootNodeName, java.lang.String publicId, java.lang.String systemId) Creates a new XML document, initializes the document based on the referenced DTD, and creates its root node.
logical	initializeDocumentType(java.lang.String namespaceUri, java.lang.String rootNodeName, java.lang.String publicId, java.lang.String systemId) Creates a new XML document, initializes the document based on the referenced DTD, and creates its root node.
private void	invalidReadWriteModeError(java.lang.String attribute) Process and display invalid node error.
logical	load(character mode, java.lang.Object source, boolean validate) Loading X-Document form file or memptr sources.
logical	load(character mode, java.lang.Object source, logical validate) Loading X-Document form file or memptr sources.
logical	load(java.lang.String mode, java.lang.Object source, boolean validate) Loading X-Document form file or memptr sources.
logical	load(java.lang.String mode, java.lang.Object source, logical validate) Loading X-Document form file or memptr sources.
character	name() Get the name attribute of handle.
void	namespacePrefix(character prefix) Setter for NAMESPACE-PREFIX attribute.
private byte[]	resolveSchemaFile(java.lang.String[] paths, java.lang.String file) Resolve the schema file from the FWD client's file-system.
protected boolean	resourceDelete() Delete the resource.
logical	save(character mode, java.lang.Object target) Saving X-Document to file or stream or memptr object.
logical	save(java.lang.String mode, java.lang.Object target) Saving X-Document to file or stream or memptr object.
void	setEncoding(character encoding) Sets the new value of the encoding attribute for the given X-Document object.
void	setEncoding(java.lang.String encoding) Sets the new value of the encoding attribute for the given X-Document object.
void	setEntityExpansionLimit(int64 limit) Set the entity expansion limit.
void	setEntityExpansionLimit(long limit) Set the entity expansion limit.
void	setNonamespaceSchemaLocation(character location) Setting the new value for the nonamespace-schema-location attribute.
void	setSchemaLocation(character schemaLocation) Determines the list of namespace/location pairs of an XML Schema file to validate against.
void	setSchemaPath(character schemaPath) A delimiter-separated list of directory paths used to locate the XML Document Type Definition (DTD) associated with a particular XML document.
void	setStrictEntityResolution(boolean strict) Enable or disable strict entity resolution.
void	setStrictEntityResolution(logical strict) Enable or disable strict entity resolution.
void	setSuppressNamespaceProcessing(boolean suppress) Redefines whether the namespace processing is suppressed or not.
void	setSuppressNamespaceProcessing(logical suppress) Redefines whether the namespace processing is suppressed or not.

Methods inherited from class com.goldencode.p2j.xml.XEntityImpl

appendChild, commonDomError, commonDomError, getChild, getChild, getNumChildren, getSubType, getUniqueID, insertBefore, invalidNodeError, isInitialized, isXEntityHandle, isXNodeHandle, isXNodeHandleInitialized, namespacePrefix, namespacePrefix, namespaceURI, namespaceURI, namespaceURI, removeAttribute, removeAttribute, removeChild, replaceChild, setNode, setNodeToHandle, setSubType, setSubType, unsupportedDomError

Methods inherited from class com.goldencode.p2j.xml.XCommonImpl

addSchemaLocation, addSchemaLocation, addSchemaLocation, hasNextSibling, hasPrevSibling, invalidArgumentAssignError, invalidArgumentError, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, setNonamespaceSchemaLocation, valid

Methods inherited from class com.goldencode.p2j.util.HandleChain

delete, firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNameReadOnly, hasParent, hasPrivateData, interlink, isChained, lastResource, lastResource, moveInChain, name, name, readOnlyError, readOnlyError, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource

_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, type, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.xml.XEntity

appendChild, getChild, getChild, getNumChildren, insertBefore, removeChild, replaceChild

Methods inherited from interface com.goldencode.p2j.xml.XCommon

addSchemaLocation, addSchemaLocation, addSchemaLocation, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, setNonamespaceSchemaLocation

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown, valid

Methods inherited from interface com.goldencode.p2j.util.UniqueID

getUniqueID

Methods inherited from interface com.goldencode.p2j.util.NamespaceURI

namespacePrefix, namespacePrefix, namespaceURI, namespaceURI, namespaceURI

Methods inherited from interface com.goldencode.p2j.util.SubTypeAttribute

getSubType, setSubType, setSubType

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

resourceType

Methods inherited from interface com.goldencode.util.Printable

asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Field Detail

xdoc

private org.w3c.dom.Document xdoc

The real document to assign with handle.

isSuppressNamespaceProcessing

private boolean isSuppressNamespaceProcessing

The flag to maintain suppress namespace processing.

schemaPaths

private java.lang.String schemaPaths

Schema paths locations variable

noNamespaceSchemaLocation

private java.lang.String noNamespaceSchemaLocation

The value of the NONAMESPACE-SCHEMA-LOCATION attribute.

schemaLocations

private java.util.Map<java.lang.String,java.lang.String> schemaLocations

The added schema locations, per namespace URI.

Constructor Detail

XDocumentImpl

public XDocumentImpl(org.w3c.dom.Document xdoc)

Associate this X-DOCUMENT resource with an existing document

Parameters:

xdoc - The real document to assign with handle.

XDocumentImpl

public XDocumentImpl()

Default constructor.

Method Detail

getNode

public org.w3c.dom.Node getNode()

Getting the Element backend object for this XEntity.

Overrides:

getNode in class XEntityImpl

Returns:

The Element associated with object.

resourceDelete

protected boolean resourceDelete()

Delete the resource.

Overrides:

resourceDelete in class XEntityImpl

Returns:

true if the resource was deleted.

namespacePrefix

public void namespacePrefix(character prefix)

Setter for NAMESPACE-PREFIX attribute.

Specified by:

namespacePrefix in interface NamespaceURI

Overrides:

namespacePrefix in class XEntityImpl

Parameters:

prefix - The new value of the NAMESPACE-PREFIX attribute.

name

public character name()

Get the name attribute of handle.

Specified by:

name in interface Nameable

Overrides:

name in class XEntityImpl

Returns:

See above.

_name

public java.lang.String _name()

Get the name attribute of handle as a string.

Overrides:

_name in class XEntityImpl

Returns:

See above.

createNode

public logical createNode(handle hChild,
                          java.lang.String name,
                          java.lang.String type)

Creating the new node within the current Document object.

Specified by:

createNode in interface XDocument

Parameters:

hChild - The valid handle class instance of the child to be created and returned on method call to use further.

name - The name of the node to be created.

type - The type of the node to be created.

Returns:

The true in case of success false otherwise.

createNode

public logical createNode(handle hChild,
                          character name,
                          java.lang.String type)

Creating the new node within the current Document object.

Specified by:

createNode in interface XDocument

Parameters:

hChild - The valid handle class instance of the child to be created and returned on method call to use further.

name - The name of the node to be created.

type - The type of the node to be created.

Returns:

The true in case of success false otherwise.

createNode

public logical createNode(handle hChild,
                          java.lang.String name,
                          character type)

Creating the new node within the current Document object.

Specified by:

createNode in interface XDocument

Parameters:

hChild - The valid handle class instance of the child to be created and returned on method call to use further.

name - The name of the node to be created.

type - The type of the node to be created.

Returns:

The true in case of success false otherwise.

createNode

public logical createNode(handle hChild,
                          character name,
                          character type)

Creating the new node within the current Document object.

Specified by:

createNode in interface XDocument

Parameters:

hChild - The valid handle class instance of the child to be created and returned on method call to use further.

name - The name of the node to be created.

type - The type of the node to be created.

Returns:

The true in case of success false otherwise.

createNodeNamespace

public logical createNodeNamespace(handle hChild,
                                   java.lang.String uri,
                                   java.lang.String name,
                                   java.lang.String type)

Creating the new node within the current Document object using different approach based on the name space URI.

Specified by:

createNodeNamespace in interface XDocument

Parameters:

hChild - The valid handle class instance of the child to be created and returned on method call to use further.

uri - The URI namespace of the node to be created.

name - The name of the node to be created.

type - The type of the node to be created.

Returns:

The true in case of success false otherwise.

createNodeNamespace

public logical createNodeNamespace(handle hChild,
                                   character uri,
                                   java.lang.String name,
                                   java.lang.String type)

Creating the new node within the current Document object using different approach based on the name space URI.

Specified by:

createNodeNamespace in interface XDocument

Parameters:

hChild - The valid handle class instance of the child to be created and returned on method call to use further.

uri - The URI namespace of the node to be created.

name - The name of the node to be created.

type - The type of the node to be created.

Returns:

The true in case of success false otherwise.

createNodeNamespace

public logical createNodeNamespace(handle hChild,
                                   java.lang.String uri,
                                   character name,
                                   java.lang.String type)

Creating the new node within the current Document object using different approach based on the name space URI.

Specified by:

createNodeNamespace in interface XDocument

Parameters:

hChild - The valid handle class instance of the child to be created and returned on method call to use further.

uri - The URI namespace of the node to be created.

name - The name of the node to be created.

type - The type of the node to be created.

Returns:

The true in case of success false otherwise.

createNodeNamespace

public logical createNodeNamespace(handle hChild,
                                   java.lang.String uri,
                                   java.lang.String name,
                                   character type)

Creating the new node within the current Document object using different approach based on the name space URI.

Specified by:

createNodeNamespace in interface XDocument

Parameters:

hChild - The valid handle class instance of the child to be created and returned on method call to use further.

uri - The URI namespace of the node to be created.

name - The name of the node to be created.

type - The type of the node to be created.

Returns:

The true in case of success false otherwise.

createNodeNamespace

public logical createNodeNamespace(handle hChild,
                                   java.lang.String uri,
                                   character name,
                                   character type)

Creating the new node within the current Document object using different approach based on the name space URI.

Specified by:

createNodeNamespace in interface XDocument

Parameters:

hChild - The valid handle class instance of the child to be created and returned on method call to use further.

uri - The URI namespace of the node to be created.

name - The name of the node to be created.

type - The type of the node to be created.

Returns:

The true in case of success false otherwise.

createNodeNamespace

public logical createNodeNamespace(handle hChild,
                                   character uri,
                                   java.lang.String name,
                                   character type)

Creating the new node within the current Document object using different approach based on the name space URI.

Specified by:

createNodeNamespace in interface XDocument

Parameters:

hChild - The valid handle class instance of the child to be created and returned on method call to use further.

uri - The URI namespace of the node to be created.

name - The name of the node to be created.

type - The type of the node to be created.

Returns:

The true in case of success false otherwise.

createNodeNamespace

public logical createNodeNamespace(handle hChild,
                                   character uri,
                                   character name,
                                   java.lang.String type)

Creating the new node within the current Document object using different approach based on the name space URI.

Specified by:

createNodeNamespace in interface XDocument

Parameters:

hChild - The valid handle class instance of the child to be created and returned on method call to use further.

uri - The URI namespace of the node to be created.

name - The name of the node to be created.

type - The type of the node to be created.

Returns:

The true in case of success false otherwise.

createNodeNamespace

public logical createNodeNamespace(handle hChild,
                                   character uri,
                                   character name,
                                   character type)

Creating the new node within the current Document object using different approach based on the name space URI.

Specified by:

createNodeNamespace in interface XDocument

Parameters:

hChild - The valid handle class instance of the child to be created and returned on method call to use further.

uri - The URI namespace of the node to be created.

name - The name of the node to be created.

type - The type of the node to be created.

Returns:

The true in case of success false otherwise.

getDocumentElement

public logical getDocumentElement(handle hRoot)

Getting the root node for the current document. The handle is placed into passed object reference.

Specified by:

getDocumentElement in interface XDocument

Parameters:

hRoot - The valid handle class instance variable to receive the result.

Returns:

The true in case of success false otherwise.

load

public logical load(java.lang.String mode,
                    java.lang.Object source,
                    logical validate)

Loading X-Document form file or memptr sources.

Specified by:

load in interface XDocument

Parameters:

mode - Variable indicating the type of source to read. "file" means reading from file, "memptr" means reading from memory buffer.

source - If mode == "file" this is the file name, if "memptr" this is the memptr object.

validate - Flag indicating whether to validate while reading or not.

Returns:

The true in case of success false otherwise.

load

public logical load(java.lang.String mode,
                    java.lang.Object source,
                    boolean validate)

Loading X-Document form file or memptr sources.

Specified by:

load in interface XDocument

Parameters:

mode - Variable indicating the type of source to read. "file" means reading from file, "memptr" means reading from memory buffer.

source - If mode == "file" this is the file name, if "memptr" this is the memptr object.

validate - Flag indicating whether to validate while reading or not.

Returns:

The true in case of success false otherwise.

load

public logical load(character mode,
                    java.lang.Object source,
                    boolean validate)

Loading X-Document form file or memptr sources.

Specified by:

load in interface XDocument

Parameters:

mode - Variable indicating the type of source to read. "file" means reading from file and source contains file name, "memptr" means reading from memory buffer.

source - If mode == "file" this is the file name, if "memptr" this is the memptr object.

validate - Flag indicating whether to validate while reading or not.

Returns:

The true in case of success false otherwise. If validate is true and xml failed validation return false but the xml document is loaded anyway.

load

public logical load(character mode,
                    java.lang.Object source,
                    logical validate)

Loading X-Document form file or memptr sources.

Specified by:

load in interface XDocument

Parameters:

mode - Variable indicating the type of source to read. "file" means reading from file and source contains file name, "memptr" means reading from memory buffer.

source - If mode == "file" this is the file name, if "memptr" this is the memptr object.

validate - Flag indicating whether to validate while reading or not. If unknown, validation will not be done.

Returns:

The true in case of success false otherwise. If validate is true and xml failed validation return false but the xml document is loaded anyway.

save

public logical save(java.lang.String mode,
                    java.lang.Object target)

Saving X-Document to file or stream or memptr object.

Specified by:

save in interface XDocument

Parameters:

mode - Variable indicating the type of target to write. "file" means writing to file, "stream" means writing to the stream and "memptr" means writing to memory buffer.

target - If mode == "file" this is the file name, if "stream" means output stream, if "memptr" this is the memptr object.

Returns:

The true in case of success false otherwise.

save

public logical save(character mode,
                    java.lang.Object target)

Saving X-Document to file or stream or memptr object.

Specified by:

save in interface XDocument

Parameters:

mode - Variable indicating the type of target to write. "file" means writing to file, "stream" means writing to the stream and "memptr" means writing to memory buffer.

target - If mode == "file" this is the file name, if "stream" means output stream, if "memptr" this is the memptr object.

Returns:

The true in case of success false otherwise.

initializeDocumentType

public logical initializeDocumentType(character namespaceUri,
                                      character rootNodeName,
                                      character publicId,
                                      character systemId)

Creates a new XML document, initializes the document based on the referenced DTD, and creates its root node.

Specified by:

initializeDocumentType in interface XDocument

Parameters:

namespaceUri - character expression representing the namespace Uniform Resource Identifier (URI) you want associated with the root node of the XML document. The namespace-uri must be unique and persistent.

rootNodeName - A character expression representing the name of the root node as defined in the XML document. If you are using namespaces and you want to associate a prefix with the namespace, you must qualify this node name with the namespace-uri and a colon character prefix (for example, namespace-uri:root-node-name). You must explicitly set the xmlns attribute on the root node.

publicId - An optional character expression representing the public ID of the DTD.

systemId - A required character expression representing the system ID of the DTD. This contains the path to the DTD which is either a file system path or an HTTP URL.

Returns:

The true in case of success false otherwise.

initializeDocumentType

public logical initializeDocumentType(character namespaceUri,
                                      java.lang.String rootNodeName,
                                      character publicId,
                                      character systemId)

Creates a new XML document, initializes the document based on the referenced DTD, and creates its root node.

Specified by:

initializeDocumentType in interface XDocument

Parameters:

namespaceUri - character expression representing the namespace Uniform Resource Identifier (URI) you want associated with the root node of the XML document. The namespace-uri must be unique and persistent.

rootNodeName - A character expression representing the name of the root node as defined in the XML document. If you are using namespaces and you want to associate a prefix with the namespace, you must qualify this node name with the namespace-uri and a colon character prefix (for example, namespace-uri:root-node-name). You must explicitly set the xmlns attribute on the root node.

publicId - An optional character expression representing the public ID of the DTD.

systemId - A required character expression representing the system ID of the DTD. This contains the path to the DTD which is either a file system path or an HTTP URL.

Returns:

The true in case of success false otherwise.

initializeDocumentType

public logical initializeDocumentType(java.lang.String namespaceUri,
                                      character rootNodeName,
                                      java.lang.String publicId,
                                      java.lang.String systemId)

Creates a new XML document, initializes the document based on the referenced DTD, and creates its root node.

Specified by:

initializeDocumentType in interface XDocument

Parameters:

namespaceUri - character expression representing the namespace Uniform Resource Identifier (URI) you want associated with the root node of the XML document. The namespace-uri must be unique and persistent.

rootNodeName - A character expression representing the name of the root node as defined in the XML document. If you are using namespaces and you want to associate a prefix with the namespace, you must qualify this node name with the namespace-uri and a colon character prefix (for example, namespace-uri:root-node-name). You must explicitly set the xmlns attribute on the root node.

publicId - An optional character expression representing the public ID of the DTD.

systemId - A required character expression representing the system ID of the DTD. This contains the path to the DTD which is either a file system path or an HTTP URL.

Returns:

The true in case of success false otherwise.

initializeDocumentType

public logical initializeDocumentType(java.lang.String namespaceUri,
                                      java.lang.String rootNodeName,
                                      java.lang.String publicId,
                                      java.lang.String systemId)

Creates a new XML document, initializes the document based on the referenced DTD, and creates its root node.

Specified by:

initializeDocumentType in interface XDocument

Parameters:

namespaceUri - character expression representing the namespace Uniform Resource Identifier (URI) you want associated with the root node of the XML document. The namespace-uri must be unique and persistent.

rootNodeName - A character expression representing the name of the root node as defined in the XML document. If you are using namespaces and you want to associate a prefix with the namespace, you must qualify this node name with the namespace-uri and a colon character prefix (for example, namespace-uri:root-node-name). You must explicitly set the xmlns attribute on the root node.

publicId - An optional character expression representing the public ID of the DTD.

systemId - A required character expression representing the system ID of the DTD. This contains the path to the DTD which is either a file system path or an HTTP URL.

Returns:

The true in case of success false otherwise.

getPublicId

public character getPublicId()

This method returns the public ID of the external DTD from which an XML document was generated.

Specified by:

getPublicId in interface XDocument

Returns:

public-id of DTD

getSystemId

public character getSystemId()

Returns the system ID of the external DTD from which an XML document was generated. This contains the path to the DTD which is either a file system path or an HTTP URL. The ABL parser uses this information to retrieve the DTD when parsing the document.

Specified by:

getSystemId in interface XDocument

Returns:

system-id of DTD

getSchemaLocation

public character getSchemaLocation()

Determines the list of namespace/location pairs of an XML Schema file to validate against.

Specified by:

getSchemaLocation in interface XmlSchema

Returns:

schema location, default value is "".

importNode

public logical importNode(handle xNodeRef,
                          handle xSourceNodeRef,
                          logical deep)

Creating the new node within the current Document object.

Specified by:

importNode in interface XDocument

Parameters:

xNodeRef - The valid handle class instance to use for the new XML node.

xSourceNodeRef - The valid handle class instance to import from.

deep - A logical that if true specifies that the whole sub-tree is to be copied. The default value is false.

Returns:

The true in case of success false otherwise.

importNode

public logical importNode(handle xNodeRef,
                          handle xSourceNodeRef,
                          boolean deep)

Creating the new node within the current Document object.

Specified by:

importNode in interface XDocument

Parameters:

xNodeRef - The valid handle class instance to use for the new XML node.

xSourceNodeRef - The valid handle class instance to import from.

deep - A boolean that if true specifies that the whole sub-tree is to be copied. The default value is false.

Returns:

The true in case of success false otherwise.

setSchemaLocation

public void setSchemaLocation(character schemaLocation)

Determines the list of namespace/location pairs of an XML Schema file to validate against.

Specified by:

setSchemaLocation in interface XmlSchema

Parameters:

schemaLocation - Determines the list of namespace/location pairs of an XML Schema file to validate against.

getEncoding

public character getEncoding()

Get encoding

Specified by:

getEncoding in interface Encoding

Returns:

encoding of xDoc

getSchemaPath

public character getSchemaPath()

A delimiter-separated list of directory paths used to locate the XML Document Type Definition (DTD) associated with a particular XML document. It is searched if the XML document contains a relative path to the DTD.

Specified by:

getSchemaPath in interface XmlSchema

Returns:

schema path, default value is unknown(?).

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the new value of the encoding attribute for the given X-Document object.

Specified by:

setEncoding in interface Encoding

Parameters:

encoding - The encoding value to be set for the given writer.

setSchemaPath

public void setSchemaPath(character schemaPath)

A delimiter-separated list of directory paths used to locate the XML Document Type Definition (DTD) associated with a particular XML document. It is searched if the XML document contains a relative path to the DTD.

Specified by:

setSchemaPath in interface XmlSchema

Parameters:

schemaPath - To separate directory paths, use a comma, or a delimiter character that your operating system recognizes.

setEncoding

public void setEncoding(character encoding)

Sets the new value of the encoding attribute for the given X-Document object.

Specified by:

setEncoding in interface Encoding

Parameters:

encoding - The encoding value to be set for the given writer.

getNonamespaceSchemaLocation

public character getNonamespaceSchemaLocation()

Gets the value of the XML schema file for elements with no namespaces.

Specified by:

getNonamespaceSchemaLocation in interface XCommon

Overrides:

getNonamespaceSchemaLocation in class XCommonImpl

Returns:

The value of the nonamespace-schema-location attribute.

setNonamespaceSchemaLocation

public void setNonamespaceSchemaLocation(character location)

Setting the new value for the nonamespace-schema-location attribute.

Specified by:

setNonamespaceSchemaLocation in interface XCommon

Overrides:

setNonamespaceSchemaLocation in class XCommonImpl

Parameters:

location - New value of the nonamespace-schema-location attribute to set.

addSchemaLocation

public logical addSchemaLocation(character namespace,
                                 character location)

Adding new match pair for namespace schema and physical file location.

Specified by:

addSchemaLocation in interface XCommon

Overrides:

addSchemaLocation in class XCommonImpl

Parameters:

namespace - Target namespace of the schema or am empty string or Unknown value.

location - Location of the XML schema file.

Returns:

The true in case of success false otherwise.

getChildNum

public integer getChildNum()

Gets the number of child for the current one. Only for XNodRef

Specified by:

getChildNum in interface XEntity

Returns:

The integer number of the child, 1-based index of the child node.

getSuppressNamespaceProcessing

public logical getSuppressNamespaceProcessing()

Indicates if the namespace processing is suppressed or not.

Specified by:

getSuppressNamespaceProcessing in interface XmlSchema

Returns:

The logical value representing the current suppress-namespace-processing attribute.

setSuppressNamespaceProcessing

public void setSuppressNamespaceProcessing(logical suppress)

Redefines whether the namespace processing is suppressed or not.

Specified by:

setSuppressNamespaceProcessing in interface XmlSchema

Parameters:

suppress - The new value the current suppress-namespace-processing attribute.

setSuppressNamespaceProcessing

public void setSuppressNamespaceProcessing(boolean suppress)

Redefines whether the namespace processing is suppressed or not.

Specified by:

setSuppressNamespaceProcessing in interface XmlSchema

Parameters:

suppress - The new value the current suppress-namespace-processing attribute.

getStrictEntityResolution

public logical getStrictEntityResolution()

Indicates if the strict entity resolution is enabled.

Specified by:

getStrictEntityResolution in interface XmlSchema

Returns:

The logical value representing the current value.

setStrictEntityResolution

public void setStrictEntityResolution(logical strict)

Enable or disable strict entity resolution.

Specified by:

setStrictEntityResolution in interface XmlSchema

Parameters:

strict - The new value for the attribute.

setStrictEntityResolution

public void setStrictEntityResolution(boolean strict)

Enable or disable strict entity resolution.

Specified by:

setStrictEntityResolution in interface XmlSchema

Parameters:

strict - The new value for the attribute.

getEntityExpansionLimit

public integer getEntityExpansionLimit()

Get the entity expansion limit.

Specified by:

getEntityExpansionLimit in interface XmlSchema

Returns:

The integer value of the attribute.

setEntityExpansionLimit

public void setEntityExpansionLimit(int64 limit)

Set the entity expansion limit.

Specified by:

setEntityExpansionLimit in interface XmlSchema

Parameters:

limit - The new value for the attribute.

setEntityExpansionLimit

public void setEntityExpansionLimit(long limit)

Set the entity expansion limit.

Specified by:

setEntityExpansionLimit in interface XmlSchema

Parameters:

limit - The new value for the attribute.

getOwnerDocument

public handle getOwnerDocument()

Getting the Document the current reference belongs to.

Specified by:

getOwnerDocument in interface XEntity

Returns:

The handle of the Document containing tne current reference.

invalidReadWriteModeError

private void invalidReadWriteModeError(java.lang.String attribute)

Process and display invalid node error. It displays appropriate error message.

Parameters:

attribute - The read-only attribute.

buildSchema

private javax.xml.validation.Schema buildSchema()

Build the validation schema using the noNamespaceSchemaLocation, schemaPaths and addSchemaLocation(com.goldencode.p2j.util.character, com.goldencode.p2j.util.character) values.

Returns:

A schema used for validation, or null if one could ont be built.

resolveSchemaFile

private byte[] resolveSchemaFile(java.lang.String[] paths,
                                 java.lang.String file)

Resolve the schema file from the FWD client's file-system.

Parameters:

paths - The paths to check against.

file - The file to locate.

Returns:

The content of the file or null if it can not be resolved.