001: /***************************************************************
002: * This file is part of the [fleXive](R) project.
003: *
004: * Copyright (c) 1999-2008
005: * UCS - unique computing solutions gmbh (http://www.ucs.at)
006: * All rights reserved
007: *
008: * The [fleXive](R) project is free software; you can redistribute
009: * it and/or modify it under the terms of the GNU General Public
010: * License as published by the Free Software Foundation;
011: * either version 2 of the License, or (at your option) any
012: * later version.
013: *
014: * The GNU General Public License can be found at
015: * http://www.gnu.org/copyleft/gpl.html.
016: * A copy is found in the textfile GPL.txt and important notices to the
017: * license from the author are found in LICENSE.txt distributed with
018: * these libraries.
019: *
020: * This library is distributed in the hope that it will be useful,
021: * but WITHOUT ANY WARRANTY; without even the implied warranty of
022: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
023: * GNU General Public License for more details.
024: *
025: * For further information about UCS - unique computing solutions gmbh,
026: * please see the company website: http://www.ucs.at
027: *
028: * For further information about [fleXive](R), please see the
029: * project website: http://www.flexive.org
030: *
031: *
032: * This copyright notice MUST APPEAR in all copies of the file!
033: ***************************************************************/package com.flexive.shared.search.query;
034:
035: import com.flexive.shared.exceptions.FxInvalidParameterException;
036: import com.flexive.shared.search.AdminResultLocations;
037: import com.flexive.shared.search.ResultLocation;
038:
039: import java.util.List;
040:
041: /**
042: * The root node of a query, containing additional information
043: * like its name or its type.
044: *
045: * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
046: */
047: public class QueryRootNode extends QueryOperatorNode {
048: private static final long serialVersionUID = 4606502650296335222L;
049:
050: /**
051: * There are substantally different query types.
052: * Currently only content searches are implemented.
053: */
054: public static enum Type {
055: /** Content search query node */
056: CONTENTSEARCH
057: }
058:
059: private String name;
060: private final Type type;
061: private final ResultLocation location;
062:
063: /**
064: * Create a new, empty query with the given parameters.
065: *
066: * @param id the node ID
067: * @param type the query type
068: * @param location the query form location (usually matches the search result location)
069: */
070: public QueryRootNode(int id, Type type, ResultLocation location) {
071: super (id, Operator.AND);
072: this .type = type;
073: this .location = location;
074: }
075:
076: /**
077: * Create a new, empty query of the given type.
078: *
079: * @param type the query type
080: */
081: public QueryRootNode(Type type) {
082: this (-1, type, AdminResultLocations.DEFAULT);
083: }
084:
085: /**
086: * Create a new, empty query with the given parameters.
087: *
088: * @param type the query type
089: * @param location the query form location (usually matches the search result location)
090: */
091: public QueryRootNode(Type type, ResultLocation location) {
092: this (-1, type, location);
093: }
094:
095: /**
096: * Create a new, empty query of the given type with the given root node id.
097: *
098: * @param id the node ID
099: * @param type the query type
100: */
101: public QueryRootNode(int id, Type type) {
102: this (id, type, AdminResultLocations.DEFAULT);
103: }
104:
105: public String getName() {
106: return name;
107: }
108:
109: public void setName(String name) {
110: this .name = name;
111: }
112:
113: public Type getType() {
114: return type;
115: }
116:
117: public ResultLocation getLocation() {
118: return location;
119: }
120:
121: /**
122: * Return a fresh node ID not used in the tree.
123: *
124: * @return a new node ID that can be used for attaching a new node to the tree
125: */
126: public int getNewId() {
127: MaxNodeIdVisitor visitor = new MaxNodeIdVisitor();
128: visit(visitor);
129: return visitor.getMaxId() + 1;
130: }
131:
132: /**
133: * Join the given nodes in a new sub hierarchy with the given operator.
134: * The new subquery is inserted in the tree level of the highest node.
135: *
136: * @param nodeIds the nodes to be joined
137: * @param operator the operator used for joining (and/or)
138: * @return the new operator node
139: */
140: public QueryOperatorNode joinNodes(List<Integer> nodeIds,
141: Operator operator) {
142: if (nodeIds == null || nodeIds.size() <= 1) {
143: throw new FxInvalidParameterException("NODEIDS",
144: "ex.queryNode.join.nodeCount").asRuntimeException();
145: }
146: QueryNode parent = null;
147: QueryOperatorNode joinNode = new QueryOperatorNode(getNewId(),
148: operator);
149: // find common parent node
150: for (int nodeId : nodeIds) {
151: final QueryNode node = findChild(nodeId);
152: if (!node.isValueNode()) {
153: throw new FxInvalidParameterException("NODEIDS",
154: "ex.queryNode.join.value").asRuntimeException();
155: }
156: if (parent == null) {
157: parent = node.getParent();
158: } else {
159: // find lowest common ancestor (LCA)
160: QueryNode nodeParent = node.getParent();
161: // reach equal depth for both parent node paths
162: while (nodeParent.getLevel() > parent.getLevel()) {
163: nodeParent = nodeParent.getParent();
164: }
165: while (parent.getLevel() > nodeParent.getLevel()) {
166: parent = parent.getParent();
167: }
168: // move upwards until we reach the same node
169: while (nodeParent != parent) {
170: nodeParent = nodeParent.getParent();
171: parent = parent.getParent();
172: }
173: // parent now points to the LCA for the nodes processed so far
174: }
175: }
176: parent.addChild(joinNode);
177: // move children
178: QueryNode currentJoinRoot = null;
179: for (int nodeId : nodeIds) {
180: final QueryNode child = findChild(nodeId);
181: removeChild(child);
182: currentJoinRoot = currentJoinRoot != null ? findChild(
183: nodeIds.get(0)).getParent() : joinNode;
184: currentJoinRoot.addChild(child);
185: }
186: // nodes may have been reattached to another operator node than joinNode, so get the parent from our first child
187: return (QueryOperatorNode) findChild(nodeIds.get(0))
188: .getParent();
189: }
190:
191: }
|