csvfieldmapping.java

java图书管理系统,系统现在自带数据库支持, 无须用户再安装数据库管理系统.

/*
 * CSVFieldMapping.java
 *
 * Copyright (C) 2005 Anupam Sengupta ([e-mail])
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * Version: $Revision: 1.3 $
 */
package net.sf.anupam.csv.mapping;

import net.sf.anupam.csv.formatters.CSVFieldFormatter;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.apache.commons.lang.builder.CompareToBuilder;

/**
 * Represents a single CSV field to Java Bean attribute mapping. The mapping can
 * be for basic data types, or point to other referenced CSV bean mappings for
 * representing nested beans.
 *
 * @author Anupam Sengupta
 * @version $Revision: 1.3 $
 * @see CSVBeanMapping
 * @since 1.5
 */
public class CSVFieldMapping implements Comparable<CSVFieldMapping> {

    /**
     * user defined name of CSV field being mapped.
     */
    private String fieldName;

    /**
     * Fully qualified class name of the field being mapped.
     */
    private String fieldType;

    /**
     * The CSV field position (starting at 0).
     */
    private int fieldPosition;

    /**
     * Name of the bean's attribute.
     */
    private String attributeName;

    /**
     * The CSV field formatter to use for this field.
     */
    private CSVFieldFormatter formatter;

    /**
     * Declarative name of the CSV field formatter to use.
     */
    private String reformatterName;

    /**
     * Declarative bean name of the being being referenced by this field
     * mapping.
     */
    private String beanReferenceName;

    /**
     * The CSV bean mapping referenced by this field mapping.
     */
    private CSVBeanMapping beanReference;

    /**
     * Constructor for CSVFieldMapping.
     */
    public CSVFieldMapping() {
        super();
    }

    /**
     * Returns the hash code for this field mapping. The hash code is based on the
     * field name and the field position.
     *
     * @return the hash code
     * @see Object#hashCode()
     */
    @Override
    public int hashCode() {
        return new HashCodeBuilder().append(fieldName).append(fieldPosition)
                .toHashCode();
    }

    /**
     * Compares this field mapping with another for equality. Field mappings are compared
     * for the name and the field position.
     *
     * @param other the other field mapping to compare against
     * @return <code>true</code> if equal, <code>false</code> otherwise
     * @see Object#equals(Object)
     */
    @Override
    public boolean equals(final Object other) {
        if (this == other) {
            return true;
        }
        if (!(other instanceof CSVFieldMapping)) {
            return false;
        }
        final CSVFieldMapping castOther = (CSVFieldMapping) other;
        return new EqualsBuilder().append(fieldName, castOther.fieldName)
                .append(fieldPosition, castOther.fieldPosition).isEquals();
    }

    /**
     * Dumps the contents of this field mapping as a string. This is meant for
     * <strong>debugging</strong> only.
     *
     * @return the string representation
     * @see Object#toString()
     */
    @Override
    public String toString() {
        final ToStringBuilder strBuilder = new ToStringBuilder(this);
        strBuilder.append("fieldName", fieldName)
                .append("fieldType", fieldType).append("fieldPosition",
                fieldPosition).append("attributeName", attributeName)
                .append("reformatterName", reformatterName);

        strBuilder.append("FormatterClass", (formatter != null ? formatter
                .getClass() : "None"));
        strBuilder.append("beanReferenceName", beanReferenceName);
        strBuilder
                .append("Bean Reference Class",
                        (beanReference != null) ? beanReference.getBeanClass()
                                : "None");
        return strBuilder.toString();
    }

    /**
     * Compares this field mapping to another mapping. The comparision is based on
     * the field position.
     *
     * @param other the other field mapping to compare to
     * @return <code>0</code> if the two field mappings are equal, <code>-1</code> if this
     *         field mapping position is less than the other's, and <code>+1</code> if this field mapping
     *         position is higher than the others.
     * @see Comparable#compareTo
     */
    public int compareTo(final CSVFieldMapping other) {
        if (this.equals(other)) {
            return 0;
        } else {
            return new CompareToBuilder().append(this.getFieldName(), other.getFieldName())
                    .append(this.getFieldPosition(), other.getFieldPosition()).toComparison();


        }

    }

    /**
     * Returns the mapped POJO bean's attribute name corresponding to this field.
     *
     * @return Returns the mapped POJO attribute name
     */
    public String getAttributeName() {
        return this.attributeName;
    }

    /**
     * Sets the mapped POJO's attribute name corresponding to this field. The name has to <strong>exactly</strong>
     * match the attribute name (including the case).
     *
     * @param attributeName The mapped POJO' attribute name
     */
    public void setAttributeName(final String attributeName) {
        this.attributeName = StringUtils.trim(attributeName);
    }

    /**
     * Returns the user defined name of this field.
     *
     * @return Returns the name of this field.
     */
    public String getFieldName() {
        return this.fieldName;
    }

    /**
     * Sets the user defined name of this field. This need not be same
     * as the CSV field name (if defined on the CSV header row).
     *
     * @param fieldName The name of this field
     */
    public void setFieldName(final String fieldName) {
        this.fieldName = StringUtils.trim(fieldName);
    }

    /**
     * Returns this field's position in the CSV line. Field positions
     * start at 0.
     *
     * @return Returns the field's position
     */
    public int getFieldPosition() {
        return this.fieldPosition;
    }

    /**
     * Sets this field's position in the CSV line. Field positions start
     * at 0.
     *
     * @param fieldPosition The field's position in the CSV line
     */
    public void setFieldPosition(final int fieldPosition) {
        this.fieldPosition = fieldPosition;
    }

    /**
     * Returns the fully qualified Java type name of this field.
     *
     * @return Returns the Java type name of this field
     */
    public String getFieldType() {
        return this.fieldType;
    }

    /**
     * Sets the fully qualified Java type name of this field.
     *
     * @param fieldType The Java type name of this field
     */
    public void setFieldType(final String fieldType) {
        this.fieldType = StringUtils.trim(fieldType);
    }

    /**
     * Returns the CSV formatter attached to this field.
     *
     * @return Returns the formatter
     */
    public CSVFieldFormatter getFormatter() {
        return this.formatter;
    }

    /**
     * Sets the formatter attached to this field.
     *
     * @param formatter The formatter to set
     */
    public void setFormatter(final CSVFieldFormatter formatter) {
        this.formatter = formatter;
    }

    /**
     * Returns the declarative name of the formatter attached to this field.
     *
     * @return Returns the declarative formatter name
     */
    public String getReformatterName() {
        return this.reformatterName;
    }

    /**
     * Sets the declarative name of the formatter attached to this field.
     *
     * @param reformatterName The declarative formatter name to set
     */
    public void setReformatterName(final String reformatterName) {
        this.reformatterName = reformatterName;
    }

    /**
     * Returns the declarative name of the referenced bean mapping for this field, or
     * <code>null</code> if no bean mapping if referenced by this field.
     *
     * @return Returns name of the referenced bean mapping
     */
    public String getBeanReferenceName() {
        return this.beanReferenceName;
    }

    /**
     * Sets the declarative name of a referenced bean mapping for this
     * field.
     *
     * @param beanReferenceName The declarative name of the referenced bean
     */
    public void setBeanReferenceName(final String beanReferenceName) {
        this.beanReferenceName = beanReferenceName;
    }

    /**
     * Sets the referenced bean mapping for this field.
     *
     * @param beanReference The bean mapping reference to set
     */
    public void setBeanReference(final CSVBeanMapping beanReference) {
        this.beanReference = beanReference;
    }

    /**
     * Returns the referenced bean mapping, if one is present. Returns
     * <code>null</code> if this field does not have any bean reference.
     *
     * @return Returns the bean mapping reference
     */
    public CSVBeanMapping getBeanReference() {
        return this.beanReference;
    }

}