Author.java

/*
 * @copyright 2011 Philip Warner
 * @license GNU General Public License
 * 
 * This file is part of Book Catalogue.
 *
 * Book Catalogue 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 3 of the License, or
 * (at your option) any later version.
 *
 * Book Catalogue 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 Book Catalogue.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.eleybourn.bookcatalogue;

import java.io.Serializable;
import java.util.ArrayList;

import android.os.Parcel;
import android.os.Parcelable;

import com.eleybourn.bookcatalogue.utils.Utils;

/**
 * Class to hold author data. Used in lists and import/export.
 * 
 * @author Philip Warner
 */
public class Author implements Serializable, Utils.ItemWithIdFixup {
	private static final long serialVersionUID = 4597779234440821872L;

	public String 	familyName;
	public String 	givenNames;
	public long		id;

	/**
	 * Constructor that will attempt to parse a single string into an author name.
	 * 
	 * @param name
	 */
	public Author(String name) {
		id = 0;
		fromString(name);
	}

	/**
	 * Constructor without ID.
	 * 
	 * @param family	Family name
	 * @param given		Given names
	 */
	Author(String family, String given) {
		this(0L, family, given);
	}

	/**
	 * Constructor
	 *
	 * @param id		ID of author in DB (0 if not in DB)
	 * @param family	Family name
	 * @param given		Given names
	 */
	Author(long id, String family, String given) {
		this.id = id;
		familyName = family.trim();
		givenNames = given.trim();
	}

	/**
	 * Return the 'human readable' version of the name (eg. 'Iassc Asimov').
	 * 
	 * @return	formatted name
	 */
	public String getDisplayName() {
		if (givenNames != null && givenNames.length() > 0)
			return givenNames + " " + familyName;
		else
			return familyName;
	}

	/**
	 * Return the name in a sortable form (eg. 'Asimov, Iassc')
	 * 
	 * @return	formatted name
	 */
	public String getSortName() {
		if (givenNames != null && givenNames.length() > 0)
			return familyName + ", " + givenNames;
		else
			return familyName;
	}

	// Support for encoding to a text file
	@Override
	public String toString() {
		// Always use givenNames even if blanks because we need to KNOW they are blank. There
		// is a slim chance that family name may contain spaces (eg. 'Anonymous Anarchists').
		return Utils.encodeListItem(familyName, ',') + ", " + Utils.encodeListItem(givenNames, ',');
	}

	//@Override
	private void fromString(String s) {
		ArrayList<String> sa = Utils.decodeList(s, ',');
		if (sa != null && sa.size() > 0) {
			if (sa.size() < 2) {
				// We have a name with no comma. Parse it the usual way.
				String[] names = CatalogueDBAdapter.processAuthorName(s);
				familyName = names[0];
				givenNames = names[1];
			} else {
				familyName = sa.get(0).trim();
				givenNames = sa.get(1).trim();			
			}
		}
	}

	/**
	 * Support for creation via Parcelable. This is primarily useful for passing
	 * ArrayList<Author> in Bundles to activities.
	 */
    public static final Parcelable.Creator<Author> CREATOR
            = new Parcelable.Creator<Author>() {
        public Author createFromParcel(Parcel in) {
            return new Author(in);
        }

        public Author[] newArray(int size) {
            return new Author[size];
        }
    };

    /**
     * Replace local details from another author
     * 
     * @param source	Author to copy
     */
    void copyFrom(Author source) {
		familyName = source.familyName;
		givenNames = source.givenNames;
		id = source.id;    	
    }

    /**
     * Constructor using a Parcel.
     * 
     * @param in
     */
    private Author(Parcel in) {
    	familyName = in.readString();
    	givenNames = in.readString();
    	id = in.readLong();
    }

	@Override
	public long fixupId(CatalogueDBAdapter db) {
		this.id = db.lookupAuthorId(this);
		return this.id;
	}
	
	@Override
	public long getId() {
		return id;
	}

	/**
	 * Each author is defined exactly by a unique ID.
	 */
	@Override
	public boolean isUniqueById() {
		return true;
	}
}