InvalidQuerySyntaxException.java

/**
 * OpenSpotLight - Open Source IT Governance Platform
 *
 * Copyright (c) 2009, CARAVELATECH CONSULTORIA E TECNOLOGIA EM INFORMATICA LTDA
 * or third-party contributors as indicated by the @author tags or express
 * copyright attribution statements applied by the authors.  All third-party
 * contributions are distributed under license by CARAVELATECH CONSULTORIA E
 * TECNOLOGIA EM INFORMATICA LTDA.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program 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 distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 *
 ***********************************************************************
 * OpenSpotLight - Plataforma de Governança de TI de Código Aberto
 *
 * Direitos Autorais Reservados (c) 2009, CARAVELATECH CONSULTORIA E TECNOLOGIA
 * EM INFORMATICA LTDA ou como contribuidores terceiros indicados pela etiqueta
 * @author ou por expressa atribuição de direito autoral declarada e atribuída pelo autor.
 * Todas as contribuições de terceiros estão distribuídas sob licença da
 * CARAVELATECH CONSULTORIA E TECNOLOGIA EM INFORMATICA LTDA.
 *
 * Este programa é software livre; você pode redistribuí-lo e/ou modificá-lo sob os
 * termos da Licença Pública Geral Menor do GNU conforme publicada pela Free Software
 * Foundation.
 *
 * Este programa é distribuído na expectativa de que seja útil, porém, SEM NENHUMA
 * GARANTIA; nem mesmo a garantia implícita de COMERCIABILIDADE OU ADEQUAÇÃO A UMA
 * FINALIDADE ESPECÍFICA. Consulte a Licença Pública Geral Menor do GNU para mais detalhes.
 *
 * Você deve ter recebido uma cópia da Licença Pública Geral Menor do GNU junto com este
 * programa; se não, escreva para:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */

package org.openspotlight.graph.query;

import org.openspotlight.graph.exception.GraphRuntimeException;

/**
 * This exception class represents any kind of sysntax error on queries - using api or text.
 * 
 * @author porcelli
 */
public class InvalidQuerySyntaxException extends GraphRuntimeException {

    private static final long serialVersionUID = 400L;

    private int               column;
    private String            errorCode        = null;
    private int               lineNumber;
    private int               offset;

    /**
     * @see java.lang.Exception#Exception(String message)
     */
    public InvalidQuerySyntaxException(
                                          final String message) {
        super(message);
    }

    /**
     * SLQueryLanguageParserException constructor.
     * 
     * @param errorCode error code
     * @param message message
     * @param lineNumber line number
     * @param column column
     * @param offset offset
     * @param cause exception cause
     */
    public InvalidQuerySyntaxException(
                                          final String errorCode, final String message, final int lineNumber, final int column,
                                       final int offset,
                                          final Throwable cause) {
        super(message, cause);
        this.errorCode = errorCode;
        this.lineNumber = lineNumber;
        this.column = column;
        this.offset = offset;
    }

    /**
     * @see java.lang.Exception#Exception(String message, Throwable cause)
     */
    public InvalidQuerySyntaxException(
                                          final String message, final Throwable cause) {
        super(message);
    }

    /**
     * @see java.lang.Exception#Exception(Throwable cause)
     */
    public InvalidQuerySyntaxException(
                                          final Throwable cause) {
        super(cause);
    }

    /**
     * getter for column position
     */
    public int getColumn() {
        return column;
    }

    /**
     * getter for error code
     */
    public String getErrorCode() {
        return errorCode;
    }

    /**
     * getter for line number
     */
    public int getLineNumber() {
        return lineNumber;
    }

    @Override
    public String getMessage() {
        if (null == errorCode) { return super.getMessage(); }
        return "[" + errorCode + "] " + super.getMessage();
    }

    /**
     * getter for char offset
     */
    public int getOffset() {
        return offset;
    }

}