org.xcmis.search.model.operand.DynamicOperand.java Source code

Introduction

Here is the source code for org.xcmis.search.model.operand.DynamicOperand.java

Source

/*
 * Copyright (C) 2009 eXo Platform SAS.
 * 
 * This is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 * 
 * This software is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this software; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF
 * site: http://www.fsf.org.
 */
package org.xcmis.search.model.operand;

import org.apache.commons.lang.Validate;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.xcmis.search.Visitors;
import org.xcmis.search.model.QueryElement;
import org.xcmis.search.model.constraint.Comparison;
import org.xcmis.search.model.source.SelectorName;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;

/**
 * A dynamic operand used in a {@link Comparison} constraint.
 */
public abstract class DynamicOperand implements QueryElement {
    private static final long serialVersionUID = 1L;

    private final Set<SelectorName> selectorNames;

    private final int hcode;

    /**
     * Create a arithmetic dynamic operand that operates upon the supplied
     * selector name(s).
     * 
     * @param selectorNames
     *           the selector names
     */
    protected DynamicOperand(Collection<SelectorName> selectorNames) {
        Validate.noNullElements(selectorNames, "The selectorNames argument may not be null");
        this.selectorNames = Collections.unmodifiableSet(new LinkedHashSet<SelectorName>(selectorNames));
        this.hcode = new HashCodeBuilder().append(selectorNames).toHashCode();

    }

    /**
     * Create a arithmetic dynamic operand that operates upon the selector names
     * given by the supplied dynamic operand(s).
     * 
     * @param operand
     *           the operand defining the selector names
     */
    protected DynamicOperand(DynamicOperand operand) {
        this(operand.getSelectorNames());
    }

    /**
     * Create a arithmetic dynamic operand that operates upon the selector names
     * given by the supplied dynamic operand(s).
     * 
     * @param operands
     *           the operands defining the selector names
     */
    protected DynamicOperand(DynamicOperand... operands) {
        Validate.noNullElements(operands, "The operands argument may not be null");

        Set<SelectorName> names = new LinkedHashSet<SelectorName>();
        for (DynamicOperand operand : operands) {
            names.addAll(operand.getSelectorNames());
        }
        this.selectorNames = Collections.unmodifiableSet(names);
        this.hcode = new HashCodeBuilder().append(selectorNames).toHashCode();
    }

    /**
     * Create a arithmetic dynamic operand that operates upon the selector names
     * given by the supplied dynamic operand(s).
     * 
     * @param operands
     *           the operands defining the selector names
     */
    protected DynamicOperand(Iterable<? extends DynamicOperand> operands) {
        Validate.notNull(operands, "The operands argument may not be null");
        if (operands == null) {
            throw new IllegalArgumentException("operands shoud not be null");
        }
        Set<SelectorName> names = new LinkedHashSet<SelectorName>();
        for (DynamicOperand operand : operands) {
            Validate.notNull(operand, "The operand argument may not be null");
            names.addAll(operand.getSelectorNames());
        }
        this.selectorNames = Collections.unmodifiableSet(names);
        this.hcode = new HashCodeBuilder().append(selectorNames).toHashCode();
    }

    /**
     * Create a arithmetic dynamic operand that operates upon the supplied
     * selector name(s).
     * 
     * @param selectorNames
     *           the selector names
     */
    protected DynamicOperand(SelectorName... selectorNames) {
        if (selectorNames.length == 1) {
            Validate.notNull(selectorNames, "The selectorNames argument may not be null");

            this.selectorNames = Collections.singleton(selectorNames[0]);
        } else {
            Validate.noNullElements(selectorNames, "The selectorNames argument may not be null");
            this.selectorNames = Collections
                    .unmodifiableSet(new LinkedHashSet<SelectorName>(Arrays.asList(selectorNames)));
        }
        this.hcode = new HashCodeBuilder().append(selectorNames).toHashCode();
    }

    /**
     * Get the selector symbols to which this operand applies.
     * 
     * @return the immutable ordered set of non-null selector names used by this
     *         operand; never null and never empty
     */
    public Set<SelectorName> getSelectorNames() {
        return selectorNames;
    }

    /**
     * {@inheritDoc}
     * 
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return Visitors.readable(this);
    }

    /**
     * {@inheritDoc}
     * 
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        return hcode;
    }

    /**
     * {@inheritDoc}
     * 
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }
        if (obj == this) {
            return true;
        }
        if (obj.getClass() != getClass()) {
            return false;
        }
        DynamicOperand rhs = (DynamicOperand) obj;
        return new EqualsBuilder().append(selectorNames, rhs.selectorNames).isEquals();
    }

}