it.unibz.inf.ontop.dbschema.impl.QuotedIDImpl Maven / Gradle / Ivy

Go to download
package it.unibz.inf.ontop.dbschema.impl;

/*
 * #%L
 * ontop-obdalib-core
 * %%
 * Copyright (C) 2009 - 2014 Free University of Bozen-Bolzano
 * %%
 * 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.
 * #L%
 */

import it.unibz.inf.ontop.dbschema.QuotedID;
import org.eclipse.jdt.annotation.NonNullByDefault;

import javax.annotation.Nullable;
import java.util.Objects;

/**
 * Database identifier used for schema names, table names and aliases
 *
 * An identifier can be in quotation marks (to preserve the case etc.).
 * Quotation, however, is ignored when identifiers are compared
 *
 * @author Roman Kontchakov
 *
 */
@NonNullByDefault
public class QuotedIDImpl implements QuotedID {

    private final String id;
    private final String quoteString;
    private final boolean caseSensitive;
    private final int hashCode;

    /**
     * (used only in QuotedIDFactory implementations)
     *
     * @param id cannot be null
     * @param quoteString the empty string stands for no quotation, as in getIdentifierQuoteString
     * @param caseSensitive specifies whether the ID is case-sensitive
     */
    QuotedIDImpl(String id, String quoteString, boolean caseSensitive) {
        this.id = Objects.requireNonNull(id);
        this.quoteString = Objects.requireNonNull(quoteString);
        this.caseSensitive = caseSensitive;
        // increases collisions but makes it possible to have case-insensitive ids (for MySQL)
        this.hashCode = id.toLowerCase().hashCode();
    }

    /**
     * returns the identifier (stripped of quotation marks)
     *
     * @return identifier without quotation marks (for comparison etc.)
     */
    @Override
    public String getName() {
        return id;
    }

    /**
     * returns SQL rendering of the identifier, in quotes, if necessary
     *
     * @return identifier possibly in quotes
     */
    @Override
    public String getSQLRendering() {
        return quoteString + id + quoteString;
    }

    @Override
    public String toString() {
        return getSQLRendering();
    }

    /**
     * compares two identifiers ignoring quotation
     */
    @Override
    public boolean equals(@Nullable Object obj) {
        if (this == obj)
            return true;

        if (obj instanceof QuotedIDImpl)  {
            QuotedIDImpl other = (QuotedIDImpl)obj;
            if (this.id.length() != other.id.length())
                return false;

            return this.id.regionMatches(
                    !this.caseSensitive || !other.caseSensitive,
                    0,
                    other.id,
                    0,
                    this.id.length());
        }
        return false;
    }

    @Override
    public int hashCode() {
        return hashCode;
    }
}