com.raritantechnologies.endeca
Class ExternalDimensionXMLGenerator

java.lang.Object
  com.raritantechnologies.endeca.ExternalDimensionXMLGenerator

All Implemented Interfaces:

IConfigurable, ITreeProcessor, ITreeXMLGenerator

public class ExternalDimensionXMLGenerator

extends java.lang.Object

implements IConfigurable, ITreeXMLGenerator, ITreeProcessor

Generates Endeca Externally Managed Taxonomy XML from a TreeRoot object.

Generates "flat" version of Endeca taxonomy XML in which each node is related to its parent node by a parent attribute pointer using the TreeNode ID as the node connector (see example below).

XML Configuration Template:

   <TreeXMLGenerator class="com.raritantechnologies.endeca.ExternalDimensionXMLGenerator"
                        fileName="[ name of output file ]"
                        searchNodes="[ true(default)|false ]"
                        synonymAttribute="[ attribute to get node synonyms ]"
                        classifySynonyms="[ true(default)|false ]"
                        searchSynonyms="[ true(default)|false ]" >

     <NodeProperties>
       <Property name="[ name of the endeca node property ]"
                    value="[ node attribute name - prefixes: Attribute:[attribute name] | ResultField:[ nested field name ] | Fixed:[ fixed value ] ]" />
     </NodeProperties>

   </TreeXMLGenerator>
 

Sample XML output:

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

static java.lang.String	ENDECA_NODE_TAG
static java.lang.String	ENDECA_ROOT_TAG

Constructor Summary

ExternalDimensionXMLGenerator()

Method Summary

java.lang.String	getXML(TreeNode node)
java.lang.String	getXML(TreeRoot tree) returns an XML string that represents data in a TreeRoot object.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	processTree(TreeRoot tree)

Methods inherited from class java.lang.Object

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

Field Detail

ENDECA_ROOT_TAG

public static final java.lang.String ENDECA_ROOT_TAG

See Also:

Constant Field Values

ENDECA_NODE_TAG

public static final java.lang.String ENDECA_NODE_TAG

See Also:

Constant Field Values

Constructor Detail

ExternalDimensionXMLGenerator

public ExternalDimensionXMLGenerator()

Method Detail

processTree

public void processTree(TreeRoot tree)

Specified by:

processTree in interface ITreeProcessor

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

getXML

public java.lang.String getXML(TreeRoot tree)

Description copied from interface: ITreeXMLGenerator

returns an XML string that represents data in a TreeRoot object.

Specified by:

getXML in interface ITreeXMLGenerator

getXML

public java.lang.String getXML(TreeNode node)