oracle.panama
Class PAPrimitive

java.lang.Object
  |
  +--oracle.panama.PAPrimitive

public class PAPrimitive

extends java.lang.Object

Contains convenient static method to create Panama Abstract Layout xmlElement, and the dependency on a particular XML parser.
These methods use the Oracle xml parser to create such elements, and return only w3c.dom.Element.
There is one more method that return the xmlDocumentElement given a xml file path name. Note :

• XML Standard : This classes should be the only parser dependent xml classes in the panama code. By this way, all the code will use Standard XML interface.
• Optimization : Note that this class will be use a by lot of concurrent thread, and should therefore, be optimized as much as possible and thread safe.
• Performance : Since this class will be used a lot, it would be good to log some performance monitor on each methods, such as to have an idea of how often is being used and how long each invocation takes.

Field Summary

Type	Field
static java.lang.String	AT_REQI_GLOBALURL
static java.lang.String	AT_REQI_PAGE
static java.lang.String	AT_REQI_SERVICENAME
static java.lang.String	AT_REQI_SERVICEURL
static java.lang.String	AT_REQI_URL
static java.lang.String	ATTR_ALT Constant for alt attribute
static java.lang.String	ATTR_EMPTYOK Constant for emptyok attribute
static java.lang.String	ATTR_FORMAT Constant for format attribute
static java.lang.String	ATTR_HREF Deprecated. replaced by ATTR_TARGET.
static java.lang.String	ATTR_LABEL Constant for value attribute
static java.lang.String	ATTR_MANDATORY Constant for mandatory attribute
static java.lang.String	ATTR_NAME Constant for name attribute
static java.lang.String	ATTR_SELECTED Constant for value attribute
static java.lang.String	ATTR_SEPARATOR Constant for separator attribute
static java.lang.String	ATTR_TARGET Constant for target attribute
static java.lang.String	ATTR_TITLE Constant for title attribute
static java.lang.String	ATTR_TYPE Constant for type attribute
static java.lang.String	ATTR_VALUE Constant for value attribute
static java.lang.String	CONSTANT_FALSE
static java.lang.String	CONSTANT_TRUE
static java.lang.String	TAG_SIMPLEACTION Constant for SimpleAction tag
static java.lang.String	TAG_SIMPLEBREAK Constant for SimpleBreak tag
static java.lang.String	TAG_SIMPLECOL Constant for SimpleCol tag
static java.lang.String	TAG_SIMPLECONTAINER Constant for SimpleContainer tag
static java.lang.String	TAG_SIMPLEEM Constant for SimpleEm tag
static java.lang.String	TAG_SIMPLEEMAIL Constant for SimpleEmail tag
static java.lang.String	TAG_SIMPLEFORM Constant for SimpleForm tag
static java.lang.String	TAG_SIMPLEFORMITEM Constant for SimpleFormItem tag
static java.lang.String	TAG_SIMPLEFORMOPTION Constant for SimpleFormOption tag
static java.lang.String	TAG_SIMPLEFORMSELECT Constant for SimpleFormSelect tag
static java.lang.String	TAG_SIMPLEHELP Constant for SimpleHelp tag
static java.lang.String	TAG_SIMPLEHREF Constant for SimpleHref tag
static java.lang.String	TAG_SIMPLEIMAGE Constant for SimpleImage tag
static java.lang.String	TAG_SIMPLEMENU Constant for SimpleMenu tag
static java.lang.String	TAG_SIMPLEMENUITEM Constant for SimpleMenuItem tag
static java.lang.String	TAG_SIMPLEMENUITEMFIELD Constant for SimpleMenuItemField tag
static java.lang.String	TAG_SIMPLEPHONE Constant for SimplePhone tag
static java.lang.String	TAG_SIMPLERESULT Constant for SimpleResult tag
static java.lang.String	TAG_SIMPLEROW Constant for SimpleRow tag
static java.lang.String	TAG_SIMPLESPAN Constant for SimpleSpan tag
static java.lang.String	TAG_SIMPLESTRONG Constant for SimpleString tag
static java.lang.String	TAG_SIMPLETABLE Constant for SimpleTable tag
static java.lang.String	TAG_SIMPLETABLEBODY Constant for SimpleTableBody tag
static java.lang.String	TAG_SIMPLETABLEHEADER Constant for SimpleTableHeader tag
static java.lang.String	TAG_SIMPLETEXT Constant for SimpleText tag
static java.lang.String	TAG_SIMPLETEXTFIELD Constant for SimpleTextField tag
static java.lang.String	TAG_SIMPLETEXTITEM Constant for SimpleTextItem tag
static java.lang.String	TAG_SIMPLETITLE Constant for SimpleTitle tag
static java.lang.String	TAG_SIMPLEUNDERLINE Constant for SimpleUnderline tag

Constructor Summary

PAPrimitive()

Method Summary

Type	Method
static org.w3c.dom.Element	addNodeListToElement(org.w3c.dom.NodeList nl, org.w3c.dom.Element targetElement)
static org.w3c.dom.Element	createElement(org.w3c.dom.Document owner, java.lang.String tagName) Create a Element with its Tag Name.
static org.w3c.dom.Element	createElement(java.lang.String tagName) Deprecated. replaced by createElement(Document, String).
static org.w3c.dom.Element	createSimpleAction(org.w3c.dom.Document owner, java.lang.String label, java.lang.String target, java.lang.String type) Create a SimpleAction with a name
static org.w3c.dom.Element	createSimpleContainer(org.w3c.dom.Document owner, java.lang.String name) Create a Simple Container Element with its name.
static org.w3c.dom.Element	createSimpleContainer(java.lang.String name) Deprecated. replaced by createSimpleContainer(Document, String).
static org.w3c.dom.Element	createSimpleForm(org.w3c.dom.Document owner, java.lang.String name, java.lang.String target) Create a Simple Form Element.
static org.w3c.dom.Element	createSimpleForm(java.lang.String name, java.lang.String target) Deprecated. replaced by createSimpleForm(Document, String, String).
static org.w3c.dom.Element	createSimpleFormItem(org.w3c.dom.Document owner, java.lang.String name, boolean isMandatory, java.lang.String defaultValue, java.lang.String text) Create a FormItem Element.
static org.w3c.dom.Element	createSimpleFormItem(java.lang.String name, boolean isMandatory, java.lang.String defaultValue, java.lang.String text) Deprecated. replaced by createSimpleForm(Document, String, String).
static org.w3c.dom.Element	createSimpleFormOption(org.w3c.dom.Document owner, java.lang.String value, java.lang.String text) Create a SimpleFormOption Element.
static org.w3c.dom.Element	createSimpleFormOption(org.w3c.dom.Document owner, java.lang.String value, java.lang.String text, boolean selected) Create a SimpleFormOption Element.
static org.w3c.dom.Element	createSimpleFormSelect(org.w3c.dom.Document owner, java.lang.String name, java.lang.String title) Create a SimpleFormSelect Element.
static org.w3c.dom.Element	createSimpleHref(org.w3c.dom.Document owner, java.lang.String label, java.lang.String target) Create a Href with a name
static org.w3c.dom.Element	createSimpleHref(org.w3c.dom.Document owner, java.lang.String label, java.lang.String target, java.lang.String type) Create a Href with a name
static org.w3c.dom.Element	createSimpleMenu(org.w3c.dom.Document owner, java.lang.String name) Create a Simple Menu Element.
static org.w3c.dom.Element	createSimpleMenu(org.w3c.dom.Document owner, java.lang.String name, java.lang.String title) Create a Simple Menu Element.
static org.w3c.dom.Element	createSimpleMenu(java.lang.String name) Deprecated. replaced by createSimpleMenu(Document, String, String).
static org.w3c.dom.Element	createSimpleMenuItem(org.w3c.dom.Document owner, java.lang.String text, java.lang.String target, boolean separatorBefore) Create a menuItem with a name
static org.w3c.dom.Element	createSimpleMenuItem(org.w3c.dom.Document owner, java.lang.String text, java.lang.String target, java.lang.String section, boolean separatorBefore) Deprecated. use instead createSimpleMenuItem( Document owner, String text, String target, boolean separatorBefore )
static org.w3c.dom.Element	createSimpleMenuItem(java.lang.String text, java.lang.String target, java.lang.String section, boolean separatorBefore) Deprecated. use instead createSimpleMenuItem( Document owner, String text, String target, boolean separatorBefore )
static org.w3c.dom.Element	createSimpleResult(org.w3c.dom.Document owner, java.lang.String name) Create a Simple Result Element with a name.
static org.w3c.dom.Element	createSimpleResult(java.lang.String name) Deprecated. replaced by createSimpleResult(Document, String).
static org.w3c.dom.Element	createSimpleText() Deprecated. replaced by createSimpleText(Document).
static org.w3c.dom.Element	createSimpleText(org.w3c.dom.Document owner) Create a Simple Text Element.
static org.w3c.dom.Element	createSimpleTextItem(org.w3c.dom.Document owner, java.lang.String name, java.lang.String text) Create a TextItem Element.
static org.w3c.dom.Element	createSimpleTextItem(java.lang.String name, java.lang.String text) Deprecated. replaced by createSimpleTextItem(Document, String, String).
static org.w3c.dom.Element	createSimpleTitle(java.lang.String text) Create a Simple Title Element.
static org.w3c.dom.Text	createText(org.w3c.dom.Document owner, java.lang.String data) Create a Text with its data.
static org.w3c.dom.Text	createText(java.lang.String data) Deprecated. replaced by createText(Document, String).
static java.lang.String	formatStringToXML(java.lang.String xmlString)
static org.w3c.dom.Element	getDocumentElement(java.io.File xmlFile)
static org.w3c.dom.Element	getDocumentElement(java.io.Reader xmlReader)
static org.w3c.dom.Element	getDocumentElement(java.lang.String xmlString)
static java.lang.String	getStringFromElement(org.w3c.dom.Element element)
static org.w3c.dom.Element	searchElement(org.w3c.dom.Element rootElement, java.lang.String tagName, java.lang.String attr1, java.lang.String value1) Search for a Element with creteria.

Methods inherited from class java.lang.Object

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

Field Detail

TAG_SIMPLECONTAINER

public static final java.lang.String TAG_SIMPLECONTAINER

Constant for SimpleContainer tag

TAG_SIMPLEFORM

public static final java.lang.String TAG_SIMPLEFORM

Constant for SimpleForm tag

TAG_SIMPLEFORMITEM

public static final java.lang.String TAG_SIMPLEFORMITEM

Constant for SimpleFormItem tag

TAG_SIMPLEFORMSELECT

public static final java.lang.String TAG_SIMPLEFORMSELECT

Constant for SimpleFormSelect tag

TAG_SIMPLEFORMOPTION

public static final java.lang.String TAG_SIMPLEFORMOPTION

Constant for SimpleFormOption tag

TAG_SIMPLEMENU

public static final java.lang.String TAG_SIMPLEMENU

Constant for SimpleMenu tag

TAG_SIMPLEMENUITEM

public static final java.lang.String TAG_SIMPLEMENUITEM

Constant for SimpleMenuItem tag

TAG_SIMPLERESULT

public static final java.lang.String TAG_SIMPLERESULT

Constant for SimpleResult tag

TAG_SIMPLETEXT

public static final java.lang.String TAG_SIMPLETEXT

Constant for SimpleText tag

TAG_SIMPLETEXTITEM

public static final java.lang.String TAG_SIMPLETEXTITEM

Constant for SimpleTextItem tag

TAG_SIMPLETABLE

public static final java.lang.String TAG_SIMPLETABLE

Constant for SimpleTable tag

TAG_SIMPLETABLEHEADER

public static final java.lang.String TAG_SIMPLETABLEHEADER

Constant for SimpleTableHeader tag

TAG_SIMPLETABLEBODY

public static final java.lang.String TAG_SIMPLETABLEBODY

Constant for SimpleTableBody tag

TAG_SIMPLEROW

public static final java.lang.String TAG_SIMPLEROW

Constant for SimpleRow tag

TAG_SIMPLECOL

public static final java.lang.String TAG_SIMPLECOL

Constant for SimpleCol tag

TAG_SIMPLEIMAGE

public static final java.lang.String TAG_SIMPLEIMAGE

Constant for SimpleImage tag

TAG_SIMPLEHREF

public static final java.lang.String TAG_SIMPLEHREF

Constant for SimpleHref tag

TAG_SIMPLEPHONE

public static final java.lang.String TAG_SIMPLEPHONE

Constant for SimplePhone tag

TAG_SIMPLEEMAIL

public static final java.lang.String TAG_SIMPLEEMAIL

Constant for SimpleEmail tag

TAG_SIMPLEBREAK

public static final java.lang.String TAG_SIMPLEBREAK

Constant for SimpleBreak tag

TAG_SIMPLEACTION

public static final java.lang.String TAG_SIMPLEACTION

Constant for SimpleAction tag

TAG_SIMPLESTRONG

public static final java.lang.String TAG_SIMPLESTRONG

Constant for SimpleString tag

TAG_SIMPLEEM

public static final java.lang.String TAG_SIMPLEEM

Constant for SimpleEm tag

TAG_SIMPLETITLE

public static final java.lang.String TAG_SIMPLETITLE

Constant for SimpleTitle tag

TAG_SIMPLESPAN

public static final java.lang.String TAG_SIMPLESPAN

Constant for SimpleSpan tag

TAG_SIMPLEUNDERLINE

public static final java.lang.String TAG_SIMPLEUNDERLINE

Constant for SimpleUnderline tag

TAG_SIMPLEHELP

public static final java.lang.String TAG_SIMPLEHELP

Constant for SimpleHelp tag

TAG_SIMPLETEXTFIELD

public static final java.lang.String TAG_SIMPLETEXTFIELD

Constant for SimpleTextField tag

TAG_SIMPLEMENUITEMFIELD

public static final java.lang.String TAG_SIMPLEMENUITEMFIELD

Constant for SimpleMenuItemField tag

ATTR_ALT

public static final java.lang.String ATTR_ALT

Constant for alt attribute

ATTR_EMPTYOK

public static final java.lang.String ATTR_EMPTYOK

Constant for emptyok attribute

ATTR_FORMAT

public static final java.lang.String ATTR_FORMAT

Constant for format attribute

ATTR_HREF

public static final java.lang.String ATTR_HREF

Deprecated. replaced by ATTR_TARGET.

Constant for href attribute

ATTR_MANDATORY

public static final java.lang.String ATTR_MANDATORY

Constant for mandatory attribute

ATTR_NAME

public static final java.lang.String ATTR_NAME

Constant for name attribute

ATTR_SEPARATOR

public static final java.lang.String ATTR_SEPARATOR

Constant for separator attribute

ATTR_TARGET

public static final java.lang.String ATTR_TARGET

Constant for target attribute

ATTR_TITLE

public static final java.lang.String ATTR_TITLE

Constant for title attribute

ATTR_TYPE

public static final java.lang.String ATTR_TYPE

Constant for type attribute

ATTR_LABEL

public static final java.lang.String ATTR_LABEL

Constant for value attribute

ATTR_VALUE

public static final java.lang.String ATTR_VALUE

Constant for value attribute

ATTR_SELECTED

public static final java.lang.String ATTR_SELECTED

Constant for value attribute

AT_REQI_URL

public static final java.lang.String AT_REQI_URL

AT_REQI_PAGE

public static final java.lang.String AT_REQI_PAGE

AT_REQI_GLOBALURL

public static final java.lang.String AT_REQI_GLOBALURL

AT_REQI_SERVICENAME

public static final java.lang.String AT_REQI_SERVICENAME

AT_REQI_SERVICEURL

public static final java.lang.String AT_REQI_SERVICEURL

CONSTANT_TRUE

public static final java.lang.String CONSTANT_TRUE

CONSTANT_FALSE

public static final java.lang.String CONSTANT_FALSE

Constructor Detail

PAPrimitive

public PAPrimitive()

Method Detail

createSimpleResult

public static org.w3c.dom.Element createSimpleResult(java.lang.String name)

Deprecated. replaced by createSimpleResult(Document, String).

Create a Simple Result Element with a name.

createSimpleResult

public static org.w3c.dom.Element createSimpleResult(org.w3c.dom.Document owner,
                                                     java.lang.String name)

Create a Simple Result Element with a name.

createSimpleContainer

public static org.w3c.dom.Element createSimpleContainer(java.lang.String name)

Deprecated. replaced by createSimpleContainer(Document, String).

Create a Simple Container Element with its name.

createSimpleContainer

public static org.w3c.dom.Element createSimpleContainer(org.w3c.dom.Document owner,
                                                        java.lang.String name)

Create a Simple Container Element with its name.

createSimpleText

public static org.w3c.dom.Element createSimpleText()

Deprecated. replaced by createSimpleText(Document).

Create a Simple Text Element.

createSimpleText

public static org.w3c.dom.Element createSimpleText(org.w3c.dom.Document owner)

Create a Simple Text Element.

createSimpleTextItem

public static org.w3c.dom.Element createSimpleTextItem(java.lang.String name,
                                                       java.lang.String text)

Deprecated. replaced by createSimpleTextItem(Document, String, String).

Create a TextItem Element.

createSimpleTextItem

public static org.w3c.dom.Element createSimpleTextItem(org.w3c.dom.Document owner,
                                                       java.lang.String name,
                                                       java.lang.String text)

Create a TextItem Element.

createSimpleFormSelect

public static org.w3c.dom.Element createSimpleFormSelect(org.w3c.dom.Document owner,
                                                         java.lang.String name,
                                                         java.lang.String title)

Create a SimpleFormSelect Element.

createSimpleFormOption

public static org.w3c.dom.Element createSimpleFormOption(org.w3c.dom.Document owner,
                                                         java.lang.String value,
                                                         java.lang.String text)

Create a SimpleFormOption Element.

createSimpleFormOption

public static org.w3c.dom.Element createSimpleFormOption(org.w3c.dom.Document owner,
                                                         java.lang.String value,
                                                         java.lang.String text,
                                                         boolean selected)

Create a SimpleFormOption Element.

createSimpleForm

public static org.w3c.dom.Element createSimpleForm(java.lang.String name,
                                                   java.lang.String target)

Deprecated. replaced by createSimpleForm(Document, String, String).

Create a Simple Form Element.

createSimpleForm

public static org.w3c.dom.Element createSimpleForm(org.w3c.dom.Document owner,
                                                   java.lang.String name,
                                                   java.lang.String target)

Create a Simple Form Element.

createSimpleTitle

public static org.w3c.dom.Element createSimpleTitle(java.lang.String text)

Create a Simple Title Element.

createSimpleFormItem

public static org.w3c.dom.Element createSimpleFormItem(java.lang.String name,
                                                       boolean isMandatory,
                                                       java.lang.String defaultValue,
                                                       java.lang.String text)

Deprecated. replaced by createSimpleForm(Document, String, String).

Create a FormItem Element.

createSimpleFormItem

public static org.w3c.dom.Element createSimpleFormItem(org.w3c.dom.Document owner,
                                                       java.lang.String name,
                                                       boolean isMandatory,
                                                       java.lang.String defaultValue,
                                                       java.lang.String text)

Create a FormItem Element.

createSimpleMenu

public static org.w3c.dom.Element createSimpleMenu(org.w3c.dom.Document owner,
                                                   java.lang.String name,
                                                   java.lang.String title)

Create a Simple Menu Element.

createSimpleMenu

public static org.w3c.dom.Element createSimpleMenu(java.lang.String name)

Deprecated. replaced by createSimpleMenu(Document, String, String).

Create a Simple Menu Element.

createSimpleMenu

public static org.w3c.dom.Element createSimpleMenu(org.w3c.dom.Document owner,
                                                   java.lang.String name)

Create a Simple Menu Element.

createSimpleMenuItem

public static org.w3c.dom.Element createSimpleMenuItem(java.lang.String text,
                                                       java.lang.String target,
                                                       java.lang.String section,
                                                       boolean separatorBefore)

Deprecated. use instead createSimpleMenuItem( Document owner, String text, String target, boolean separatorBefore )

Create a menuItem with a name

createSimpleMenuItem

public static org.w3c.dom.Element createSimpleMenuItem(org.w3c.dom.Document owner,
                                                       java.lang.String text,
                                                       java.lang.String target,
                                                       java.lang.String section,
                                                       boolean separatorBefore)

Deprecated. use instead createSimpleMenuItem( Document owner, String text, String target, boolean separatorBefore )

Create a menuItem with a name

createSimpleMenuItem

public static org.w3c.dom.Element createSimpleMenuItem(org.w3c.dom.Document owner,
                                                       java.lang.String text,
                                                       java.lang.String target,
                                                       boolean separatorBefore)

Create a menuItem with a name

createSimpleHref

public static org.w3c.dom.Element createSimpleHref(org.w3c.dom.Document owner,
                                                   java.lang.String label,
                                                   java.lang.String target,
                                                   java.lang.String type)

Create a Href with a name

createSimpleHref

public static org.w3c.dom.Element createSimpleHref(org.w3c.dom.Document owner,
                                                   java.lang.String label,
                                                   java.lang.String target)

Create a Href with a name

createSimpleAction

public static org.w3c.dom.Element createSimpleAction(org.w3c.dom.Document owner,
                                                     java.lang.String label,
                                                     java.lang.String target,
                                                     java.lang.String type)

Create a SimpleAction with a name

addNodeListToElement

public static org.w3c.dom.Element addNodeListToElement(org.w3c.dom.NodeList nl,
                                                       org.w3c.dom.Element targetElement)

createElement

public static org.w3c.dom.Element createElement(java.lang.String tagName)

Deprecated. replaced by createElement(Document, String).

Create a Element with its Tag Name.

createElement

public static org.w3c.dom.Element createElement(org.w3c.dom.Document owner,
                                                java.lang.String tagName)

Create a Element with its Tag Name.

createText

public static org.w3c.dom.Text createText(java.lang.String data)

Deprecated. replaced by createText(Document, String).

Create a Text with its data.

createText

public static org.w3c.dom.Text createText(org.w3c.dom.Document owner,
                                          java.lang.String data)

Create a Text with its data.

getDocumentElement

public static org.w3c.dom.Element getDocumentElement(java.io.File xmlFile)
                                              throws java.lang.Exception

getDocumentElement

public static org.w3c.dom.Element getDocumentElement(java.io.Reader xmlReader)
                                              throws java.lang.Exception

getDocumentElement

public static org.w3c.dom.Element getDocumentElement(java.lang.String xmlString)
                                              throws java.lang.Exception

getStringFromElement

public static java.lang.String getStringFromElement(org.w3c.dom.Element element)
                                             throws java.lang.Exception

formatStringToXML

public static java.lang.String formatStringToXML(java.lang.String xmlString)
                                          throws java.lang.Exception

searchElement

public static org.w3c.dom.Element searchElement(org.w3c.dom.Element rootElement,
                                                java.lang.String tagName,
                                                java.lang.String attr1,
                                                java.lang.String value1)

Search for a Element with creteria. If attr1 is null return first Element with tagName

Parameters:

rootElement -

stagName -

attr1 -

value1 -

Returns:

Element