net.sf.flatpack.ordering.OrderColumn Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flatpack
Simple Java delimited and fixed width file parser. Handles CSV, Excel CSV, Tab, Pipe delimiters, just to name a few. Maps column positions in the file to user friendly names via XML. See FlatPack Feature List under News for complete feature list.
There is a newer version: 4.0.18
Show newest version
/*
 * ObjectLab, http://www.objectlab.co.uk/open is supporting FlatPack.
 *
 * Based in London, we are world leaders in the design and development
 * of bespoke applications for the securities financing markets.
 *
 * Click here to learn more
 *           ___  _     _           _   _          _
 *          / _ \| |__ (_) ___  ___| |_| |    __ _| |__
 *         | | | | '_ \| |/ _ \/ __| __| |   / _` | '_ \
 *         | |_| | |_) | |  __/ (__| |_| |__| (_| | |_) |
 *          \___/|_.__// |\___|\___|\__|_____\__,_|_.__/
 *                   |__/
 *
 *                     www.ObjectLab.co.uk
 *
 * $Id: ColorProvider.java 74 2006-10-24 22:19:05Z benoitx $
 *
 * Copyright 2006 the original author or authors.
 *
 * 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.
 */
package net.sf.flatpack.ordering;

/**
 * @author paul zepernick
 *
 * Used in conjunction with the OrderBy class. Holds the name of the column to
 * order by and the direction the order should go, ASC, DESC.
 *
 * @version 2.0
 */
public class OrderColumn {

    /**Specifies descending sort order*/
    public static final boolean DESC = true;

    /**Specifies Ascending sort order*/
    public static final boolean ASC = false;

    /**string sort indicator*/
    public static final int COLTYPE_STRING = 0;

    /**date sort indicator*/
    public static final int COLTYPE_DATE = 1;

    /**numeric sort indicator*/
    public static final int COLTYPE_NUMERIC = 2;

    // property name to sort by
    private String columnName;

    // 1 = ASC -1 = DESC
    private int sortIndicator = 1;

    private int selectedColType;

    private String dateFormatPattern = "yyyyMMdd";

    /**
     * Constructs a new order by element
     *
     * @param columnName
     *            column to sort by
     * @param desc
     *            boolean sort DESC.  OrderColumn.DESC, OrderColumn.ASC
     * @param colType
     *            Type of column to be sorted: OrderColumn.COLTYPE_STRING,OrderColumn.COLTYPE_DATE, OrderColum.COLTYPE_NUMERIC
     */
    public OrderColumn(final String columnName, final boolean desc, final int colType) {
        this.columnName = columnName;
        this.selectedColType = colType;

        if (desc) {
            this.sortIndicator = -1;
        }
    }

    /**
     * Constructs a new order by element
     *
     * @param columnName
     *            column to sort by
     * @param desc
     *            boolean sort DESC.  OrderColumn.DESC, OrderColumn.ASC
     */
    public OrderColumn(final String columnName, final boolean desc) {
        this(columnName, desc, OrderColumn.COLTYPE_STRING);
    }

    /**
     * @return Returns the propertyName.
     */
    public String getColumnName() {
        return columnName;
    }

    /**
     * @param columnName
     *            The columnName to set.
     */
    public void setColumnName(final String columnName) {
        this.columnName = columnName;
    }

    /**
     * @return Returns the sortIndicator.
     */
    public int getSortIndicator() {
        return sortIndicator;
    }

    /**
     * @return the selectedColType
     */
    public int getSelectedColType() {
        return selectedColType;
    }

    /**
     * @param selectedColType the selectedColType to set
     */
    public void setSelectedColType(final int selectedColType) {
        this.selectedColType = selectedColType;
    }

    /**
     * Format pattern to use to parse dates for sorting.  Default is yyyyMMdd
     *
     * @return the dateFormatPattern
     */
    public String getDateFormatPattern() {
        return dateFormatPattern;
    }

    /**
     * Format pattern to use to parse dates for sorting.  Default is yyyyMMdd
     *
     * @param dateFormatPattern the dateFormatPattern to set
     * @see java.text.SimpleDateFormat

     */
    public void setDateFormatPattern(final String dateFormatPattern) {
        this.dateFormatPattern = dateFormatPattern;
    }
}