node

The branches or clusters of the cluster tree. Each node can contain other nodes, or be the "more" node. The node elements allow you to interact with the clusters (expand or contract) by appending the ts, ls, or bs attribute values to the tree element's base-url attribute.

Table 1. Cluster Node Description
Attribute	Type	Description
type	One of: top, close, open, more	top: the root node close: the folder is closed open: the folder is open (and the node will have sub-nodes) more: contains a single ts attribute used to show more clusters
level	Non-negative integer	Level of the folder within the tree (root is 0).
ndocs	Non-negative integer	Number of documents within the folder.
active	0 or 1	Indicates which node the current list of documents belong to (only one node should be active at a time).
subnodes	Non-negative integer	The number of nodes (clusters) underneath the current node.
ts	Text	Append this value to tree/@base-url to expand this cluster.
ls	Text	Append this value to tree/@base-url to view the docs under this cluster (and make this the active node).
bs	Text	Append this value to tree/@base-url to expand this cluster and view the docs within it (making it the active node).

Example:

<tree base-url="http://yoursite.com/search?v%3aproject=xml-feed&v%3afile=viv_195%4024%3aT3Zujs&v:state=">
  <node type="top" level="0" ndocs="100" active="1" subnodes="19" ts="|root-20-20" ls="root|root" bs="|root">
  <node type="close" level="1" ndocs="29" subnodes="11" ts="(root(N496))|root-20-20" ls="root|N496" bs="(root(N496))|N496">
  <description>Travel</description>
  </node>
  <node type="close" level="1" ndocs="11" subnodes="4" ts="(root(N309))|root-20-20" ls="root|N309" bs="(root(N309))|N309">
  <description>Vacation packages</description>
  </node>
  <node type="close" level="1" ndocs="14" subnodes="4" ts="(root(N346))|root-20-20" ls="root|N346" bs="(root(N346))|N346">
  <description>Florida</description>
  </node>
  <node type="close" level="1" ndocs="10" subnodes="3" ts="(root(N406))|root-20-20" ls="root|N406" bs="(root(N406))|N406">
  <description>Owner</description>
  </node>
  <node type="close" level="1" ndocs="8" subnodes="3" ts="(root(N555))|root-20-20" ls="root|N555" bs="(root(N555))|N555">
  <description>Prices, Cruise</description>
  </node>
  <node type="close" level="1" ndocs="7" subnodes="2" ts="(root(N386))|root-20-20" ls="root|N386" bs="(root(N386))|N386">
  <description>Apartments, Vacation Rentals, Villa</description>
  </node>
  <node type="close" level="1" ndocs="5" subnodes="2" ts="(root(N444))|root-20-20" ls="root|N444" bs="(root(N444))|N444">
  <description>Europe, Vacation Rentals, Vacation</description>
  </node>
  <node type="close" level="1" ndocs="6" subnodes="3" ts="(root(N292))|root-20-20" ls="root|N292" bs="(root(N292))|N292">
  <description>Bed And Breakfasts</description>
  </node>
  <node type="close" level="1" ndocs="6" subnodes="2" ts="(root(N326))|root-20-20" ls="root|N326" bs="(root(N326))|N326">
  <description>Hotels And Vacation Rentals</description>
  </node>
  <node type="close" level="1" ndocs="5" subnodes="3" ts="(root(N204))|root-20-20" ls="root|N204" bs="(root(N204))|N204">
  <description>Attractions, Gatlinburg</description>
  </node>
  <node type="more" ts="(root-0-20)|root-20-20"/>
  </node>
  </tree>

Tree interaction examples

Note: these are only examples and will not work if you enter them into your browser because the v:file parameter refers to a temporary file.

Example - expand the first cluster from the tree (Travel):

http://yoursite.com/search?v%3aproject=query-meta&v%3afile=viv_195%4024%3aT3Zujs&v:state=(root(N496))|root-20-20

Example - select the eighth cluster from the tree (Bed And Breakfasts):

http://yoursite.com/search?v%3aproject=query-meta&v%3afile=viv_195%4024%3aT3Zujs&v:state=root|N292

Example - expand and select the second cluster from the tree (Vacation packages):

http://yoursite.com/search?v%3aproject=query-meta&v%3afile=viv_195%4024%3aT3Zujs&v:state=(root(N309))|N309

To get the entire cluster tree (with all the nodes open), you can add the v:state=rootopen|root CGI parameter to a request, as in the following example:

http://yoursite.com/search?query=Form+1040&render.function=xml-feed-display&content-type=text/xml&v:state=rootopen|root

To get the whole XML state, you can add the v:fullstate=1 CGI parameter to the request, as in the following example:

http://yoursite.com/search?query=Form+1040&render.function=xml-feed-display&content-type=text/xml&v:fullstate=1