OrderByTypeInfo.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.info;

import java.io.Serializable;

/**
 * The Class SLOrderByTypeInfo.
 * 
 * @author Vitor Hugo Chagas
 */
public class OrderByTypeInfo implements Serializable {

    /**
     * The Enum OrderType.
     * 
     * @author Vitor Hugo Chagas
     */
    public static enum OrderType {

        /** The ASCENDING. */
        ASCENDING,

        /** The DESCENDING. */
        DESCENDING
    }

    /** The Constant serialVersionUID. */
    private static final long    serialVersionUID = 1L;

    /** The order by statement info. */
    private OrderByStatementInfo orderByStatementInfo;

    /** The order type. */
    private OrderType            orderType        = OrderType.ASCENDING;

    /** The property name. */
    private String               propertyName;

    /** The sub types. */
    private boolean              subTypes;

    /** The type name. */
    private String               typeName;

    /**
     * Gets the order by statement info.
     * 
     * @return the order by statement info
     */
    public OrderByStatementInfo getOrderByStatementInfo() {
        return orderByStatementInfo;
    }

    /**
     * Gets the order type.
     * 
     * @return the order type
     */
    public OrderType getOrderType() {
        return orderType;
    }

    /**
     * Gets the property name.
     * 
     * @return the property name
     */
    public String getPropertyName() {
        return propertyName;
    }

    /**
     * Gets the type name.
     * 
     * @return the type name
     */
    public String getTypeName() {
        return typeName;
    }

    /**
     * Checks if is sub types.
     * 
     * @return true, if is sub types
     */
    public boolean isSubTypes() {
        return subTypes;
    }

    /**
     * Sets the order by statement info.
     * 
     * @param orderByStatementInfo the new order by statement info
     */
    public void setOrderByStatementInfo(final OrderByStatementInfo orderByStatementInfo) {
        this.orderByStatementInfo = orderByStatementInfo;
    }

    /**
     * Sets the order type.
     * 
     * @param orderType the new order type
     */
    public void setOrderType(final OrderType orderType) {
        this.orderType = orderType;
    }

    /**
     * Sets the property name.
     * 
     * @param propertyName the new property name
     */
    public void setPropertyName(final String propertyName) {
        this.propertyName = propertyName;
    }

    /**
     * Sets the sub types.
     * 
     * @param subTypes the new sub types
     */
    public void setSubTypes(final boolean subTypes) {
        this.subTypes = subTypes;
    }

    /**
     * Sets the type name.
     * 
     * @param typeName the new type name
     */
    public void setTypeName(final String typeName) {
        this.typeName = typeName;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        final StringBuilder buffer = new StringBuilder();
        buffer.append("\t").append('"').append(typeName);
        if (subTypes) {
            buffer.append(".*");
        }
        buffer.append("\" property \"").append(propertyName).append("\" ").append(orderType).append('\n');

        return buffer.toString();
    }
}