/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2007 - 2008, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2008 - 2009, Johann Sorel
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation;
 *    version 2.1 of the License.
 *
 *    This library 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.
 */
package org.geotoolkit.gui.javafx.crs;

// OpenGIS dependencies
import org.apache.sis.util.ArgumentChecks;
import org.opengis.referencing.AuthorityFactory;
import org.opengis.referencing.IdentifiedObject;
import org.opengis.util.FactoryException;


/**
 * This element stores the {@linkplain #code code value}.
 * The description name will be fetched when first needed and returned by {@link #toString}.
 *
 * @version $Id$
 * @author Martin Desruisseaux (IRD)
 * @module
 */
final class Code {

    /**
     * The authority code.
     */
    public final String code;

    /**
     * The CRS object description for the {@linkplain #code}.
     * Will be extracted only when first needed.
     */
    private String name;
    
    private String description;

    /**
     * The authority factory to use for fetching the name. Will be set to {@code null} after
     * {@linkplain #name} has been made available, in order to allow the garbage collector
     * to do its work if possible.
     */
    private final AuthorityFactory factory;

    /**
     * Creates a code from the specified value.
     *
     * @param factory The authority factory.
     * @param code The authority code.
     */
    public Code(final AuthorityFactory factory, final String code) {
        ArgumentChecks.ensureNonNull("factory", factory);
        ArgumentChecks.ensureNonNull("code", code);
        this.factory = factory;
        this.code    = code;
    }

    /**
     * Create the Object identified by code.
     * 
     * @return IdentifiedObject
     * @throws FactoryException 
     */
    public IdentifiedObject createObject() throws FactoryException{
        return factory.createObject(code);
    }
    
    /**
     * Returns a description of the object.
     * 
     * @return 
     */
    public String getDescription(){
        if (description == null) try {
            description = factory.getDescriptionText(code).toString();
        } catch (FactoryException e) {
            description = e.getLocalizedMessage();
        }
        return description;
    }
    
    /**
     * Returns the name for this code.
     *
     * @todo Maybe we should use the widget Locale when invoking InternationalString.toString(...).
     */
    @Override
    public String toString() {
        if(name==null){
            name = code + " - "+getDescription();
        }
        return name;
    }
}