com.goldencode.p2j.xml

Class XmlPatternWorker

java.lang.Object

com.goldencode.p2j.pattern.AbstractPatternWorker

com.goldencode.p2j.convert.AbstractConversionWorker

com.goldencode.p2j.xml.XmlPatternWorker

All Implemented Interfaces:

PatternWorker, XmlTokenTypes

public final class XmlPatternWorker
extends AbstractConversionWorker
implements XmlTokenTypes

A pattern worker that provides services to support the manipulation of XML ASTs and their persistence in document object model (DOM) form.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	XmlPatternWorker.Library Helper to create, edit, move and delete XML ASTs.

Field Summary

Fields

Modifier and Type	Field and Description
private static CentralLogger	LOG Logger

Fields inherited from class com.goldencode.p2j.convert.AbstractConversionWorker

PEER_ID

Fields inherited from interface com.goldencode.p2j.xml.XmlTokenTypes

ATTR_SET, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, CONTENT, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, INTERNAL_SUBSET, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, PUBLIC_ID, SYSTEM_ID, TEXT_NODE

Constructor Summary

Constructors

Constructor and Description
XmlPatternWorker() Default constructor which initializes callback library.

Method Summary

Modifier and Type	Method and Description
static Aast	createAst(int type, java.lang.String text, Aast parent) General purpose XML AST creation function which can create a XmlAst node using the given token type and text.
static java.lang.String	getAttributeValue(Aast attrSet, java.lang.String name) Scan all attributes for the given AST set and return the one which matches with the given name (case-sensitively).
private boolean	matchAttribute(Aast attrSet, java.lang.String name, java.lang.String value) Scan all attributes in the given attribute set AST and determine whether any of them match the given name and value parameters.
java.lang.Object	resolveConstant(java.lang.String constant) Resolve constant to a literal which can be compiled into expressions.

Methods inherited from class com.goldencode.p2j.convert.AbstractConversionWorker

crossReferencePeerAsts, getClosestPeerId, getParentPeer, initializeAst, initializeAst, initializeRootAst, initializeRootAst

Methods inherited from class com.goldencode.p2j.pattern.AbstractPatternWorker

getCopy, getLibrary, getResolver, getSource, isConditionalRuleSets, isFlagActivated, isRuntimeQueryMode, registerTree, setLibrary

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.pattern.PatternWorker

finish, initialize, leaveAst, visitAst

Field Detail

LOG

private static final CentralLogger LOG

Logger

Constructor Detail

XmlPatternWorker

public XmlPatternWorker()

Default constructor which initializes callback library.

Method Detail

createAst

public static Aast createAst(int type,
                             java.lang.String text,
                             Aast parent)

General purpose XML AST creation function which can create a XmlAst node using the given token type and text. The created node will then be attached to the specified parent. This is used in cases where the conversion is simple enough to drive it completely from the rule set rather than from a custom worker.

Parameters:

type - The token type for the XML AST.

text - The text for the AST.

parent - The ID of the parent AST node.

Returns:

The unique ID if the AST was created successfully or null if the parent ID is invalid, if the type is not valid or on any unexpected error during AST creation.

getAttributeValue

public static java.lang.String getAttributeValue(Aast attrSet,
                                                 java.lang.String name)

Scan all attributes for the given AST set and return the one which matches with the given name (case-sensitively).

Parameters:

attrSet - AST set which to be searched

name - Target attribute name for which the value is retrieved.

Returns:

the attribute value, if there is such an attribute; null otherways

See Also:

matchAttribute(Aast, String, String)

resolveConstant

public java.lang.Object resolveConstant(java.lang.String constant)

Resolve constant to a literal which can be compiled into expressions.

Specified by:

resolveConstant in interface PatternWorker

Overrides:

resolveConstant in class AbstractPatternWorker

Parameters:

constant - Constant indicating a XML token name.

Returns:

Token type associated with the token name.

matchAttribute

private boolean matchAttribute(Aast attrSet,
                               java.lang.String name,
                               java.lang.String value)

Scan all attributes in the given attribute set AST and determine whether any of them match the given name and value parameters. Both the name and value must match exactly (case-sensitively).

The normal AST hierarchy for the value of an attribute is ATTRIBUTE_NODE with a child of type CONTENT. However, there are casess when a TEXT node exists between the ATTRIBUTE_NODE and the CONTENT node. To handle this case, the search is performed in a depth-first way. After the ATTRIBUTE_NODE with the correct name is found, the next CONTENT node in the depth-first traversal will be the value to be checked.

Parameters:

attrSet - Attribute set AST to scan.

name - Target attribute name to match.

value - Target attribute value to match.

Returns:

true if the given attribute set contains an attribute which exactly matches the given name and value; else false.