org.apache.jackrabbit.spi.commons.query.RelationQueryNode Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jackrabbit.spi.commons.query;
import java.util.Date;
import javax.jcr.RepositoryException;
import org.apache.jackrabbit.spi.Name;
import org.apache.jackrabbit.spi.Path;
import org.apache.jackrabbit.spi.Path.Element;
import org.apache.jackrabbit.spi.commons.name.NameFactoryImpl;
/**
* Implements a query node that defines property value relation.
*/
public class RelationQueryNode extends NAryQueryNode implements QueryConstants {
/**
* Acts as an synthetic placeholder for a location step that matches any
* name. This is required because a JCR path does not allow a Name with
* a single '*' (star) character.
*/
public static final Name STAR_NAME_TEST = NameFactoryImpl.getInstance().create(Name.NS_REP_URI, "__star__");
/**
* The relative path to the property.
*/
private PathQueryNode relPath;
/**
* If true this relation query node contains a value preceded
* with an unary minus.
*/
private boolean unaryMinus;
/**
* The long value of the relation if this is a query is of type
* long
*/
private long valueLong;
/**
* The int value of the position index.
*/
private int valuePosition;
/**
* The double value of the relation if this is a query is of
* type double
*/
private double valueDouble;
/**
* The String value of the relation if this is a query is of
* type String
*/
private String valueString;
/**
* The Date value of the relation if this is a query is of type
* Date
*/
private Date valueDate;
/**
* The operation type of this relation. One of the operation values defined
* in {@link QueryConstants}.
*/
private final int operation;
/**
* The value type of this relation. One of {@link #TYPE_DATE}, {@link
* #TYPE_DOUBLE}, {@link #TYPE_LONG}, {@link #TYPE_STRING}, {@link #TYPE_POSITION}.
*/
private int type;
private final QueryNodeFactory factory;
/**
* Creates a new RelationQueryNode without a type nor value
* assigned.
*
* @param parent the parent node for this query node.
* @param operation the operation.
* @param factory the query node factory.
*/
protected RelationQueryNode(QueryNode parent,
int operation,
QueryNodeFactory factory) {
super(parent);
this.operation = operation;
this.factory = factory;
this.relPath = factory.createPathQueryNode(this);
}
/**
* {@inheritDoc}
* @throws RepositoryException
*/
public Object accept(QueryNodeVisitor visitor, Object data) throws RepositoryException {
return visitor.visit(this, data);
}
/**
* Returns the type of this node.
*
* @return the type of this node.
*/
public int getType() {
return QueryNode.TYPE_RELATION;
}
/**
* If b is true then the value in this relation
* node contains a receding unary minus.
*
* @param b true if this relation contains a unary minus.
*/
public void setUnaryMinus(boolean b) {
unaryMinus = b;
}
/**
* Returns the type of the value.
*
* @return the type of the value.
*/
public int getValueType() {
return type;
}
/**
* @return the relative path that references the property in this relation.
*/
public PathQueryNode getRelativePath() {
return relPath;
}
/**
* Sets the relative path to the property in this relation.
*
* @param relPath the relative path to a property.
* @throws IllegalArgumentException if relPath is absolute.
*/
public void setRelativePath(Path relPath) {
if (relPath.isAbsolute()) {
throw new IllegalArgumentException("relPath must be relative");
}
Element[] elements = relPath.getElements();
for (Element element : elements) {
addPathElement(element);
}
}
/**
* Adds a path element to the existing relative path. To add a path element
* which matches all node names use {@link #STAR_NAME_TEST}.
*
* @param element the path element to append.
*/
public void addPathElement(Path.Element element) {
LocationStepQueryNode step = factory.createLocationStepQueryNode(relPath);
if (element.getName().equals(STAR_NAME_TEST)) {
step.setNameTest(null);
} else {
step.setNameTest(element.getName());
}
relPath.addPathStep(step);
}
/**
* Returns the long value if this relation if of type
* {@link #TYPE_LONG}.
*
* @return the long value.
*/
public long getLongValue() {
return valueLong;
}
/**
* Sets a new value of type long.
*
* @param value the new value.
*/
public void setLongValue(long value) {
valueLong = unaryMinus ? -value : value;
type = TYPE_LONG;
}
/**
* Returns the int position index value if this relation is
* of type {@link #TYPE_POSITION}.
* @return the position index value.
*/
public int getPositionValue() {
return valuePosition;
}
/**
* Sets a new value for the position index.
*
* @param value the new value.
*/
public void setPositionValue(int value) {
valuePosition = value;
type = TYPE_POSITION;
}
/**
* Returns the double value if this relation if of type
* {@link #TYPE_DOUBLE}.
*
* @return the double value.
*/
public double getDoubleValue() {
return valueDouble;
}
/**
* Sets a new value of type double.
*
* @param value the new value.
*/
public void setDoubleValue(double value) {
valueDouble = unaryMinus ? -value : value;
type = TYPE_DOUBLE;
}
/**
* Returns the String value if this relation if of type
* {@link #TYPE_STRING}.
*
* @return the String value.
*/
public String getStringValue() {
return valueString;
}
/**
* Sets a new value of type String.
*
* @param value the new value.
*/
public void setStringValue(String value) {
valueString = value;
type = TYPE_STRING;
}
/**
* Returns the Date value if this relation if of type
* {@link #TYPE_DATE}.
*
* @return the Date value.
*/
public Date getDateValue() {
return valueDate;
}
/**
* Sets a new value of type Date.
*
* @param value the new value.
*/
public void setDateValue(Date value) {
valueDate = value;
type = TYPE_DATE;
}
/**
* Returns the operation type.
*
* @return the operation type.
*/
public int getOperation() {
return operation;
}
/**
* @inheritDoc
*/
public boolean equals(Object obj) {
if (obj instanceof RelationQueryNode) {
RelationQueryNode other = (RelationQueryNode) obj;
return type == other.type
&& (valueDate == null ? other.valueDate == null : valueDate.equals(other.valueDate))
&& valueDouble == other.valueDouble
&& valueLong == other.valueLong
&& valuePosition == other.valuePosition
&& (valueString == null ? other.valueString == null : valueString.equals(other.valueString))
&& (relPath == null ? other.relPath == null : relPath.equals(other.relPath));
}
return false;
}
}