com.goldencode.p2j.xml

Class SaxEntityImpl

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

com.goldencode.p2j.xml.XCommonImpl

com.goldencode.p2j.xml.SaxEntityImpl

All Implemented Interfaces:

ADMData, CommonHandle, CommonHandleChain, Deletable, InstantiatingProcedure, Nameable, UniqueID, WrappedResource, SaxEntity, XCommon, Printable

Direct Known Subclasses:

SaxAttributesImpl, SaxReaderImpl, SaxWriterImpl

public class SaxEntityImpl
extends XCommonImpl
implements SaxEntity

Implementation the common features for SAX Reader, SAX Writer and SAX Attributes Progress support objects.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	admData amd-data variable.
private java.lang.Long	uniqueId unique value for a given handle object type within an 4gl session.

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
SaxEntityImpl() Default constructor.

Method Summary

Modifier and Type	Method and Description
character	getADMData() Get the value of the ADM-DATA attribute.
integer	getUniqueID() Gets the the unique ID number associated to this object by the underlying system.
logical	insertAttribute(java.lang.String name, java.lang.String value) Adding the single attribute to the start tag in the XML document if applied for SAX writer object.
logical	insertAttribute(java.lang.String name, java.lang.String value, java.lang.String uri) Adding the single attribute to the start tag in the XML document if applied for SAX writer object.
logical	insertAttribute(java.lang.String name, java.lang.String value, Text uri) Adding the single attribute to the start tag in the XML document if applied for SAX writer object.
logical	insertAttribute(java.lang.String name, Text value) Adding the single attribute to the start tag in the XML document if applied for SAX writer object.
logical	insertAttribute(java.lang.String name, Text value, java.lang.String uri) Adding the single attribute to the start tag in the XML document if applied for SAX writer object.
logical	insertAttribute(java.lang.String name, Text value, Text uri) Adding the single attribute to the start tag in the XML document if applied for SAX writer object.
logical	insertAttribute(Text name, java.lang.String value) Adding the single attribute to the start tag in the XML document if applied for SAX writer object.
logical	insertAttribute(Text name, java.lang.String value, java.lang.String uri) Adding the single attribute to the start tag in the XML document if applied for SAX writer object.
logical	insertAttribute(Text name, java.lang.String value, Text uri) Adding the single attribute to the start tag in the XML document if applied for SAX writer object.
logical	insertAttribute(Text name, Text value) Adding the single attribute to the start tag in the XML document if applied for SAX writer object.
logical	insertAttribute(Text name, Text value, java.lang.String uri) Adding the single attribute to the start tag in the XML document if applied for SAX writer object.
logical	insertAttribute(Text name, Text value, Text uri) Adding the single attribute to the start tag in the XML document if applied for SAX writer object.
protected void	invalidReadWriteModeError(java.lang.String attribute) Process and display invalid read/write mode error.
protected void	invalidStatusAttributeError(java.lang.String attribute, SaxWriter.WriteStatus status) Process and display invalid status error.
protected void	invalidStatusMethodError(java.lang.String method, SaxWriter.WriteStatus status) Process and display invalid status error.
logical	removeAttribute(character name, character uri) Removes the specified attribute.
logical	removeAttribute(NumberType index, character uri) Removes the specified attribute.
void	setADMData(character value) Set the value of the ADM-DATA attribute.
void	setADMData(java.lang.String value) Set the value of the ADM-DATA attribute.
protected void	writerOutputError(java.lang.String method) Process and display invalid status error.

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

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

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

_name, delete, firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNameReadOnly, hasParent, hasPrivateData, interlink, isChained, lastResource, lastResource, moveInChain, name, 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.XCommon

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

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

id, id, unknown, valid

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

uniqueId

private java.lang.Long uniqueId

unique value for a given handle object type within an 4gl session.

admData

private java.lang.String admData

amd-data variable.

Constructor Detail

SaxEntityImpl

public SaxEntityImpl()

Default constructor.

Method Detail

getUniqueID

public integer getUniqueID()

Gets the the unique ID number associated to this object by the underlying system. Not the same as the handle value itself.

Specified by:

getUniqueID in interface UniqueID

Returns:

The unique integer value for a given handle object type within an 4gl session.

getADMData

public character getADMData()

Get the value of the ADM-DATA attribute.

Specified by:

getADMData in interface ADMData

Returns:

See above.

setADMData

public void setADMData(java.lang.String value)

Set the value of the ADM-DATA attribute.

Specified by:

setADMData in interface ADMData

Parameters:

value - The new value.

setADMData

public void setADMData(character value)

Set the value of the ADM-DATA attribute.

Specified by:

setADMData in interface ADMData

Parameters:

value - The new value.

insertAttribute

public logical insertAttribute(java.lang.String name,
                               Text value,
                               Text uri)

Adding the single attribute to the start tag in the XML document if applied for SAX writer object. For SAX attributes object inserts attribute and its name into SAX attributes object.

Specified by:

insertAttribute in interface SaxEntity

Parameters:

name - The attribute name to insert.

value - The attribute value to insert.

uri - The URI of the attribute to insert or '?' for unknown value.

Returns:

The true in case of success false otherwise.

insertAttribute

public logical insertAttribute(Text name,
                               java.lang.String value,
                               Text uri)

Adding the single attribute to the start tag in the XML document if applied for SAX writer object. For SAX attributes object inserts attribute and its name into SAX attributes object.

Specified by:

insertAttribute in interface SaxEntity

Parameters:

name - The attribute name to insert.

value - The attribute value to insert.

uri - The URI of the attribute to insert or '?' for unknown value.

Returns:

The true in case of success false otherwise.

insertAttribute

public logical insertAttribute(Text name,
                               Text value,
                               java.lang.String uri)

Adding the single attribute to the start tag in the XML document if applied for SAX writer object. For SAX attributes object inserts attribute and its name into SAX attributes object.

Specified by:

insertAttribute in interface SaxEntity

Parameters:

name - The attribute name to insert.

value - The attribute value to insert.

uri - The URI of the attribute to insert or '?' for unknown value.

Returns:

The true in case of success false otherwise.

insertAttribute

public logical insertAttribute(java.lang.String name,
                               java.lang.String value,
                               Text uri)

Adding the single attribute to the start tag in the XML document if applied for SAX writer object. For SAX attributes object inserts attribute and its name into SAX attributes object.

Specified by:

insertAttribute in interface SaxEntity

Parameters:

name - The attribute name to insert.

value - The attribute value to insert.

uri - The URI of the attribute to insert or '?' for unknown value.

Returns:

The true in case of success false otherwise.

insertAttribute

public logical insertAttribute(java.lang.String name,
                               Text value,
                               java.lang.String uri)

Adding the single attribute to the start tag in the XML document if applied for SAX writer object. For SAX attributes object inserts attribute and its name into SAX attributes object.

Specified by:

insertAttribute in interface SaxEntity

Parameters:

name - The attribute name to insert.

value - The attribute value to insert.

uri - The URI of the attribute to insert or '?' for unknown value.

Returns:

The true in case of success false otherwise.

insertAttribute

public logical insertAttribute(Text name,
                               java.lang.String value,
                               java.lang.String uri)

Adding the single attribute to the start tag in the XML document if applied for SAX writer object. For SAX attributes object inserts attribute and its name into SAX attributes object.

Specified by:

insertAttribute in interface SaxEntity

Parameters:

name - The attribute name to insert.

value - The attribute value to insert.

uri - The URI of the attribute to insert or '?' for unknown value.

Returns:

The true in case of success false otherwise.

insertAttribute

public logical insertAttribute(java.lang.String name,
                               java.lang.String value,
                               java.lang.String uri)

Adding the single attribute to the start tag in the XML document if applied for SAX writer object. For SAX attributes object inserts attribute and its name into SAX attributes object.

Specified by:

insertAttribute in interface SaxEntity

Parameters:

name - The attribute name to insert.

value - The attribute value to insert.

uri - The URI of the attribute to insert or '?' for unknown value.

Returns:

The true in case of success false otherwise.

insertAttribute

public logical insertAttribute(java.lang.String name,
                               Text value)

Adding the single attribute to the start tag in the XML document if applied for SAX writer object. For SAX attributes object inserts attribute and its name into SAX attributes object.

Specified by:

insertAttribute in interface SaxEntity

Parameters:

name - The attribute name to insert.

value - The attribute value to insert.

Returns:

The true in case of success false otherwise.

insertAttribute

public logical insertAttribute(Text name,
                               java.lang.String value)

Adding the single attribute to the start tag in the XML document if applied for SAX writer object. For SAX attributes object inserts attribute and its name into SAX attributes object.

Specified by:

insertAttribute in interface SaxEntity

Parameters:

name - The attribute name to insert.

value - The attribute value to insert.

Returns:

The true in case of success false otherwise.

insertAttribute

public logical insertAttribute(java.lang.String name,
                               java.lang.String value)

Adding the single attribute to the start tag in the XML document if applied for SAX writer object. For SAX attributes object inserts attribute and its name into SAX attributes object.

Specified by:

insertAttribute in interface SaxEntity

Parameters:

name - The attribute name to insert.

value - The attribute value to insert.

Returns:

The true in case of success false otherwise.

insertAttribute

public logical insertAttribute(Text name,
                               Text value)

Adding the single attribute to the start tag in the XML document if applied for SAX writer object. For SAX attributes object inserts attribute and its name into SAX attributes object.

Specified by:

insertAttribute in interface SaxEntity

Parameters:

name - The attribute name to insert.

value - The attribute value to insert.

Returns:

The true in case of success false otherwise.

insertAttribute

public logical insertAttribute(Text name,
                               Text value,
                               Text uri)

Adding the single attribute to the start tag in the XML document if applied for SAX writer object. For SAX attributes object inserts attribute and its name into SAX attributes object.

Specified by:

insertAttribute in interface SaxEntity

Parameters:

name - The attribute name to insert.

value - The attribute value to insert.

uri - The URI of the attribute to insert or '?' for unknown value.

Returns:

The true in case of success false otherwise.

removeAttribute

public logical removeAttribute(character name,
                               character uri)

Removes the specified attribute.

Specified by:

removeAttribute in interface XCommon

Parameters:

name - The name of the attribute to remove.

uri - The URI of the attribute to remove.

Returns:

The true in case of success false otherwise.

removeAttribute

public logical removeAttribute(NumberType index,
                               character uri)

Removes the specified attribute.

Specified by:

removeAttribute in interface XCommon

Parameters:

index - The 1-based index of the attribute to remove.

uri - The URI of the attribute to remove.

Returns:

The true in case of success false otherwise.

invalidReadWriteModeError

protected void invalidReadWriteModeError(java.lang.String attribute)

Process and display invalid read/write mode error. It displays appropriate error message.

Parameters:

attribute - The read-only attribute.

invalidStatusAttributeError

protected void invalidStatusAttributeError(java.lang.String attribute,
                                           SaxWriter.WriteStatus status)

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

Parameters:

attribute - The read-only attribute.

status - Current status of SAX-WRITER.

writerOutputError

protected void writerOutputError(java.lang.String method)

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

Parameters:

method - The 4gl method name..

invalidStatusMethodError

protected void invalidStatusMethodError(java.lang.String method,
                                        SaxWriter.WriteStatus status)

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

Parameters:

method - The 4gl method name.

status - Current status of SAX-WRITER.