|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.netuix.application.transform.disassembler.XmlDisassemblerContext
public abstract class XmlDisassemblerContext
The XmlDisassemblerContext object represents contextual information needed by the disassembler, including the source of the xml document, entity and error handlers, and locale information. It is used in a read-only manner by the disassembler subsystem.
Constructor Summary | |
---|---|
XmlDisassemblerContext(InputStream xmlIn)
|
Method Summary | |
---|---|
abstract DesktopDefinitionId |
getDesktopDefinitionId()
Implementations of this method must return an appropriate id (as specified) for the portal document. |
com.bea.p13n.org.jdom.Document |
getDocument()
Parse the xml stream. |
abstract Locale |
getDocumentLocale()
Implementations of this method are required to return the Locale for the document being processed. |
com.bea.p13n.util.DefaultEntityResolver |
getEntityResolver()
|
com.bea.netuix.xml.util.NetuixXMLErrorHandler |
getErrorHandler()
|
com.bea.p13n.org.jdom.Namespace |
getNetuixNamespace()
|
abstract String |
getWebAppName()
This method retrieves the name of the current WebApp module for which the .portlet file is deployed. |
protected InputStream |
getXmlStream()
This method should only be called if getDocument() is overridden. |
protected void |
inspectDocument(com.bea.p13n.org.jdom.Document document)
This method may be optionally overridden by subclasses in order to inspect the document immediately after processing. |
protected void |
invalidateXmlStream()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XmlDisassemblerContext(InputStream xmlIn)
xmlIn
- an input stream to the portal xml file to be disassembled.Method Detail |
---|
public com.bea.p13n.org.jdom.Document getDocument() throws XmlDisassemblerException
XmlDisassemblerException
public abstract Locale getDocumentLocale() throws XmlDisassemblerException
Locale
for the document being processed.
Locale
appropriate for the document being processed
XmlDisassemblerException
- Indicates a problem fetching the required locale informationpublic abstract DesktopDefinitionId getDesktopDefinitionId() throws XmlDisassemblerException
DesktopDefinitionId
instance capable of uniquely identifying the document
XmlDisassemblerException
- Indicates a problem fetching the required id informationpublic abstract String getWebAppName()
The name is the deployed name of the module, and is often the name of the WAR file or directory, although this is not always the case. This name is that name given in config.xml as the Name of the WebAppComponent element (and thus WebAppComponentMBean's Name attribute). Note that this name is not the name of the URL context root.
ApplicationHelper.getWebAppName(javax.servlet.ServletContext)
protected void inspectDocument(com.bea.p13n.org.jdom.Document document) throws XmlDisassemblerException
document
- The newly parsed document
XmlDisassemblerException
- Indicates a problem fetching information from the documentprotected InputStream getXmlStream()
getDocument()
is overridden. If called after a call to
getDocument()
is made (and if not overridden itself), this method may return an invalid stream or null.
protected void invalidateXmlStream()
public com.bea.p13n.util.DefaultEntityResolver getEntityResolver()
public com.bea.netuix.xml.util.NetuixXMLErrorHandler getErrorHandler()
public com.bea.p13n.org.jdom.Namespace getNetuixNamespace()
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |