/*$************************************************************************************************
 **
 ** $Id: NameFactory.java 831 2006-05-01 00:27:23Z Desruisseaux $
 **
 ** $URL: http://svn.code.sf.net/p/geoapi/code/branches/2.0.x/geoapi/src/main/java/org/opengis/util/NameFactory.java $
 **
 ** Copyright (C) 2003-2005 Open GIS Consortium, Inc.
 ** All Rights Reserved. http://www.opengis.org/legal/
 **
 *************************************************************************************************/
package org.opengis.util;

// J2SE direct dependencies
import java.util.Locale;
import java.util.Map;


/**
 * Factory for {@linkplain GenericName generic names} and
 * {@linkplain InternationalString international strings}.
 * 
 * @author Jesse Crossley (SYS Technologies)
 * @since GeoAPI 2.0
 */
public interface NameFactory {    
    /**
     * Creates an international string from a set of strings in different locales.
     *
     * @param strings String value for each locale key.
     */
    InternationalString createInternationalString(Map strings);
    
    /**
     * Creates a local name from a scope and a name. This method creates a name similar to the one
     * created by {@linkplain #createScopedName createScopedName}(…same
     * parameters…{@code )}, except that methods like
     * {@link LocalName#getParsedNames() getParsedNames()} and {@link LocalName#toString() toString()}
     * do not include the scope.
     *
     * @param scope The scope to be returned by {@link LocalName#getScope}, or {@code null} if none.
     * @param name  The unlocalized name.
     * @param localizedName A localized version of the name.
     */
    LocalName createLocalName(GenericName scope, String name, InternationalString localizedName);
    
    /**
     * Creates a scoped name from a scope and a name. This method creates a name similar to the one
     * created by {@linkplain #createLocalName createLocalName}(…same
     * parameters…{@code )}, except that methods like
     * {@link ScopedName#getParsedNames() getParsedNames()} and {@link ScopedName#toString() toString()}
     * include the scope.
     *
     * @param scope The scope to be returned by {@link ScopedName#getScope}.
     * @param name  The unlocalized name.
     * @param localizedName A localized version of the name.
     */
    ScopedName createScopedName(GenericName scope, String name, InternationalString localizedName);
}

 

Ads help maintain this website.