com.ontimize.util.extend

Class ExtendedXmlParser

java.lang.Object

com.ontimize.util.extend.ExtendedXmlParser

Direct Known Subclasses:

ExtendedFormXmlParser, ExtendedRemoteReferencesXmlParser

public abstract class ExtendedXmlParser
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD_REMOTE_REFERENCE
static String	ATTR_ATRIBUTE
static String	CONTAINER_ATRIBUTE
static boolean	DEBUG
static String	FORM_EXTENDS
static String	INSERT_AFTER_OP
static String	INSERT_BEFORE_OP
static String	LEVELS_ATRIBUTE
static String	MENU_EXTENDS
static String	MODIFY_ATTRIBUTE
static String	MODIFY_ATTRIBUTE_NAME
static String	MODIFY_ATTRIBUTE_OPERATION
static String	MODIFY_ATTRIBUTE_OPERATOR_ADD
static String	MODIFY_ATTRIBUTE_OPERATOR_REMOVE
static String	MODIFY_ATTRIBUTE_SEPARATOR
static String	MODIFY_ATTRIBUTE_VALUE
static String	MODIFY_FORM
static String	MODIFY_REFERENCE_CLASS
static String	MODIFY_REFERENCE_INIT
static String	MODIFY_REFERENCE_MODIFY_CLASS
static String	MODIFY_REFERENCE_MODIFY_INIT
static String	MODIFY_REFERENCE_MODIFY_NAME
static String	MODIFY_REFERENCE_NAME
static String	MODIFY_REFERENCE_PARAMS
static String	MODIFY_REFERENCE_PARAMS_VAL
static String	MODIFY_REFERENCE_VALUE
static String	MODIFY_REMOTE_REFERENCE
static String	ORDER
static String	REMOVE_OP
static String	REMOVE_REMOTE_REFERENCE
static String	REPLACE_OP
static String	TOOLBAR_EXTENDS

Constructor Summary

Constructors

Constructor and Description
ExtendedXmlParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkNodeWithoutAttributes(Node node) Returns true or false if the node doesn't need attributes
protected abstract void	executeOperation(Document originalForm, ExtendedXmlOperation operation)
protected ArrayList	extractOperationNodes(Document extendDocument) This method iterate along the extend document extracting all nodes of operations
Document	getDocumentModel(File f)
Document	getExtendedDocument(Document doc, Enumeration<URL> input)
Document	getExtendedDocumentForm(Document doc, String fileURI, String baseClasspath)
static String	getExtendedFile(String fileURI)
static Enumeration<URL>	getExtendedFile(String fileURI, String baseCP)
static InputStream	getExtendedInput(String fileURI)
protected ExtendedXmlOperation	getNodeOperation(Node node) This method processes a node that contains an operation and returns an instance of class XmlExtendsOperation with necessary information to apply this operation in original xml document
protected boolean	isExtendedNode(Node node) Returns true or false if the node parameter is a operation node
protected Document	parse(Document originalForm, Document extendDocument) Executes all operations in extendDocument to modify the xml code in originalDocument
Document	parseExtendedXml(Document originalForm, Document extendDocument)
String	printDocument(Document document)

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static boolean DEBUG

INSERT_AFTER_OP

public static final String INSERT_AFTER_OP

See Also:

Constant Field Values

INSERT_BEFORE_OP

public static final String INSERT_BEFORE_OP

See Also:

Constant Field Values

REMOVE_OP

public static final String REMOVE_OP

See Also:

Constant Field Values

REPLACE_OP

public static final String REPLACE_OP

See Also:

Constant Field Values

ATTR_ATRIBUTE

public static final String ATTR_ATRIBUTE

See Also:

Constant Field Values

CONTAINER_ATRIBUTE

public static final String CONTAINER_ATRIBUTE

See Also:

Constant Field Values

LEVELS_ATRIBUTE

public static final String LEVELS_ATRIBUTE

See Also:

Constant Field Values

FORM_EXTENDS

public static final String FORM_EXTENDS

See Also:

Constant Field Values

MENU_EXTENDS

public static final String MENU_EXTENDS

See Also:

Constant Field Values

TOOLBAR_EXTENDS

public static final String TOOLBAR_EXTENDS

See Also:

Constant Field Values

MODIFY_FORM

public static final String MODIFY_FORM

See Also:

Constant Field Values

ORDER

public static final String ORDER

See Also:

Constant Field Values

MODIFY_ATTRIBUTE_NAME

public static final String MODIFY_ATTRIBUTE_NAME

See Also:

Constant Field Values

MODIFY_ATTRIBUTE_VALUE

public static final String MODIFY_ATTRIBUTE_VALUE

See Also:

Constant Field Values

MODIFY_ATTRIBUTE_SEPARATOR

public static final String MODIFY_ATTRIBUTE_SEPARATOR

See Also:

Constant Field Values

MODIFY_ATTRIBUTE_OPERATION

public static final String MODIFY_ATTRIBUTE_OPERATION

See Also:

Constant Field Values

MODIFY_ATTRIBUTE

public static final String MODIFY_ATTRIBUTE

See Also:

Constant Field Values

MODIFY_ATTRIBUTE_OPERATOR_ADD

public static final String MODIFY_ATTRIBUTE_OPERATOR_ADD

See Also:

Constant Field Values

MODIFY_ATTRIBUTE_OPERATOR_REMOVE

public static final String MODIFY_ATTRIBUTE_OPERATOR_REMOVE

See Also:

Constant Field Values

ADD_REMOTE_REFERENCE

public static final String ADD_REMOTE_REFERENCE

See Also:

Constant Field Values

MODIFY_REMOTE_REFERENCE

public static final String MODIFY_REMOTE_REFERENCE

See Also:

Constant Field Values

REMOVE_REMOTE_REFERENCE

public static final String REMOVE_REMOTE_REFERENCE

See Also:

Constant Field Values

MODIFY_REFERENCE_MODIFY_NAME

public static final String MODIFY_REFERENCE_MODIFY_NAME

See Also:

Constant Field Values

MODIFY_REFERENCE_MODIFY_CLASS

public static final String MODIFY_REFERENCE_MODIFY_CLASS

See Also:

Constant Field Values

MODIFY_REFERENCE_MODIFY_INIT

public static final String MODIFY_REFERENCE_MODIFY_INIT

See Also:

Constant Field Values

MODIFY_REFERENCE_PARAMS

public static final String MODIFY_REFERENCE_PARAMS

See Also:

Constant Field Values

MODIFY_REFERENCE_PARAMS_VAL

public static final String MODIFY_REFERENCE_PARAMS_VAL

See Also:

Constant Field Values

MODIFY_REFERENCE_NAME

public static final String MODIFY_REFERENCE_NAME

See Also:

Constant Field Values

MODIFY_REFERENCE_VALUE

public static final String MODIFY_REFERENCE_VALUE

See Also:

Constant Field Values

MODIFY_REFERENCE_CLASS

public static final String MODIFY_REFERENCE_CLASS

See Also:

Constant Field Values

MODIFY_REFERENCE_INIT

public static final String MODIFY_REFERENCE_INIT

See Also:

Constant Field Values

Constructor Detail

ExtendedXmlParser

public ExtendedXmlParser()

Method Detail

executeOperation

protected abstract void executeOperation(Document originalForm,
                    ExtendedXmlOperation operation)
                                  throws Exception

Throws:

Exception

parseExtendedXml

public Document parseExtendedXml(Document originalForm,
                        Document extendDocument)
                          throws Exception

Throws:

Exception

parse

protected Document parse(Document originalForm,
             Document extendDocument)
                  throws Exception

Executes all operations in extendDocument to modify the xml code in originalDocument

Parameters:

originalForm - - The xml of the original file

extendDocument - - The xml containing the operations to apply in originalDocument

Returns:

Throws:

Exception

getNodeOperation

protected ExtendedXmlOperation getNodeOperation(Node node)
                                         throws Exception

This method processes a node that contains an operation and returns an instance of class XmlExtendsOperation with necessary information to apply this operation in original xml document

Parameters:

node - The node of operation

Returns:

An instance of class XmlExtendsOperation

Throws:

Exception

extractOperationNodes

protected ArrayList extractOperationNodes(Document extendDocument)

This method iterate along the extend document extracting all nodes of operations

Parameters:

extendDocument -

Returns:

checkNodeWithoutAttributes

protected boolean checkNodeWithoutAttributes(Node node)

Returns true or false if the node doesn't need attributes

Parameters:

node - the node to check

Returns:

true or false

isExtendedNode

protected boolean isExtendedNode(Node node)

Returns true or false if the node parameter is a operation node

Parameters:

node - the node to check

Returns:

true or false

getDocumentModel

public Document getDocumentModel(File f)

printDocument

public String printDocument(Document document)

getExtendedFile

public static String getExtendedFile(String fileURI)

getExtendedInput

public static InputStream getExtendedInput(String fileURI)

getExtendedFile

public static Enumeration<URL> getExtendedFile(String fileURI,
                               String baseCP)

getExtendedDocument

public Document getExtendedDocument(Document doc,
                           Enumeration<URL> input)

getExtendedDocumentForm

public Document getExtendedDocumentForm(Document doc,
                               String fileURI,
                               String baseClasspath)