extras/rya.indexing.pcj/src/main/java/org/apache/rya/indexing/pcj/storage/PeriodicQueryStorageMetadata.java

/*
 * 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.rya.indexing.pcj.storage;

import java.util.Objects;

import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.rya.indexing.pcj.storage.accumulo.VariableOrder;

import com.google.common.base.Preconditions;

/**
 *  Metadata for a given PeriodicQueryStorage table. 
 */
public class PeriodicQueryStorageMetadata {

    private String sparql;
    private VariableOrder varOrder;

    /**
     * Create a PeriodicQueryStorageMetadata object
     * @param sparql - SPARQL query whose results are stored in table
     * @param varOrder - order that BindingSet values are written in in table
     */
    public PeriodicQueryStorageMetadata(String sparql, VariableOrder varOrder) {
        this.sparql = Preconditions.checkNotNull(sparql);
        this.varOrder = Preconditions.checkNotNull(varOrder);
    }
    
    /**
     * Copy constructor.
     * @param metadata - PeriodicQueryStorageMetadata object whose data is copied
     */
    public PeriodicQueryStorageMetadata(PcjMetadata metadata) {
        this(metadata.getSparql(), metadata.getVarOrders().iterator().next());
    }
    

    /**
     * @return SPARQL query whose results are stored in the table
     */
    public String getSparql() {
        return sparql;
    }
    
    /**
     * @return VariableOrder indicating the order that BindingSet Values are written in in table
     */
    public VariableOrder getVariableOrder() {
        return varOrder;
    }
    
    @Override
    public int hashCode() {
        return Objects.hash(sparql, varOrder);
    }
   
    @Override
    public boolean equals(final Object o) {
        if (o == this) {
            return true;
        }

        if (o instanceof PeriodicQueryStorageMetadata) {
                PeriodicQueryStorageMetadata metadata = (PeriodicQueryStorageMetadata) o;
                return new EqualsBuilder().append(sparql, metadata.sparql).append(varOrder, metadata.varOrder).isEquals();
        }

        return false;
    }
    
    @Override
    public String toString() {
        return new StringBuilder()
                .append("PeriodicQueryStorageMetadata {\n")
                .append("    SPARQL: " + sparql + "\n")
                .append("    Variable Order: " + varOrder + "\n")
                .append("}")
                .toString();
    }
    
    
}