org.efaps.db.QueryKey Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation

eFaps is a framework used to map objects with or without attached files to a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface. The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.

The newest version!

/*
 * Copyright 2003 - 2013 The eFaps Team
 *
 * Licensed 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.
 *
 * Revision:        $Rev$
 * Last Changed:    $Date$
 * Last Changed By: $Author$
 */

package org.efaps.db;

import java.io.Serializable;

import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import org.hibernate.search.annotations.Analyze;
import org.hibernate.search.annotations.Field;
import org.hibernate.search.annotations.Indexed;

/**
 * TODO comment!
 *
 * @author The eFaps Team
 * @version $Id$
 */
@Indexed
public final class QueryKey
    implements Serializable
{
    /**
     *
     */
    private static final long serialVersionUID = 1L;

    /**
     * The sql statement executed.
     */
    private final String sql;

    /**
     * The name of the sql statement.
     */
    @Field(analyze = Analyze.NO)
    private final String key;

    /**
     * @param _key key
     * @param _sql sql statement
     */
    private QueryKey(final String _key,
                     final String _sql)
    {
        this.key = _key;
        this.sql = _sql;
    }

    /**
     * Getter method for the instance variable {@link #sql}.
     *
     * @return value of instance variable {@link #sql}
     */
    public String getSql()
    {
        return this.sql;
    }

    /**
     * Getter method for the instance variable {@link #key}.
     *
     * @return value of instance variable {@link #key}
     */
    public String getKey()
    {
        return this.key;
    }

    /**
     * @return string used as unique value for indexing
     */
    protected String getIndexKey()
    {
        return getKey() + getSql();
    }

    /**
     * @return id represented by this instance
     */
    @Override
    public int hashCode()
    {
        return this.key.hashCode();
    }

    /**
     * @param _obj Object to compare
     * @return true if the given object in _obj is an instance and holds
     *         the same type and id
     */
    @Override
    public boolean equals(final Object _obj)
    {
        boolean ret = false;
        if (_obj instanceof QueryKey) {
            final QueryKey queryKey = (QueryKey) _obj;
            ret = getKey().equals(queryKey.getKey()) && getSql().equals(queryKey.getSql());
        } else {
            super.equals(_obj);
        }
        return ret;
    }

    @Override
    public String toString()
    {
        return ToStringBuilder.reflectionToString(this, ToStringStyle.SHORT_PREFIX_STYLE);
    }

    /**
     * @param _key key
     * @param _sql sql
     * @return new QueryKey
     */
    public static QueryKey get(final String _key,
                               final String _sql)
    {
        return new QueryKey(_key, _sql);
    }
}