com.eteks.sweethome3d.io

Class DefaultFurnitureCatalog

java.lang.Object

com.eteks.sweethome3d.model.FurnitureCatalog

com.eteks.sweethome3d.io.DefaultFurnitureCatalog

public class DefaultFurnitureCatalog
extends FurnitureCatalog

Furniture default catalog read from resources localized in .properties files.

Author:

Emmanuel Puybaret

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultFurnitureCatalog.PropertyKey The keys of the properties values read in .properties files.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PLUGIN_FURNITURE_CATALOG_FAMILY The name of .properties family files in plugin furniture catalog files.

Constructor Summary

Constructors

Constructor and Description
DefaultFurnitureCatalog() Creates a default furniture catalog read from resources in the package of this class.
DefaultFurnitureCatalog(java.io.File furniturePluginFolder) Creates a default furniture catalog read from resources and furniture plugin folder if furniturePluginFolder isn't null.
DefaultFurnitureCatalog(java.net.URL[] pluginFurnitureCatalogUrls) Creates a default furniture catalog read only from resources in the given URLs.
DefaultFurnitureCatalog(java.net.URL[] pluginFurnitureCatalogUrls, java.net.URL furnitureResourcesUrlBase) Creates a default furniture catalog read only from resources in the given URLs or in the classpath if the security manager doesn't allow to create class loaders.
DefaultFurnitureCatalog(UserPreferences preferences, java.io.File furniturePluginFolder) Creates a default furniture catalog read from resources and furniture plugin folder if furniturePluginFolder isn't null.
DefaultFurnitureCatalog(UserPreferences preferences, java.io.File[] furniturePluginFolders) Creates a default furniture catalog read from resources and furniture plugin folders if furniturePluginFolders isn't null.

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,Content>	getAdditionalContents(java.util.ResourceBundle resource, int index, java.net.URL furnitureCatalogUrl, java.net.URL furnitureResourcesUrlBase) Returns the contents of the piece at the given index different from default properties.
protected java.util.Map<java.lang.String,java.lang.String>	getAdditionalProperties(java.util.ResourceBundle resource, int index) Returns the properties of the piece at the given index different from default properties.
java.util.List<Library>	getLibraries() Returns the furniture libraries at initialization.
protected boolean	isDefaultProperty(java.lang.String keyPrefix) Returns true if the given parameter is the prefix of a default property used as an attribute of a piece of furniture.
protected FurnitureCategory	readFurnitureCategory(java.util.ResourceBundle resource, int index) Returns the furniture category of a piece at the given index of a localized resource bundle.
protected CatalogPieceOfFurniture	readPieceOfFurniture(java.util.ResourceBundle resource, int index, java.net.URL furnitureCatalogUrl, java.net.URL furnitureResourcesUrlBase) Returns the piece of furniture at the given index of a localized resource bundle.

Methods inherited from class com.eteks.sweethome3d.model.FurnitureCatalog

add, addFurnitureListener, delete, getCategories, getCategoriesCount, getCategory, getPieceOfFurnitureWithId, removeFurnitureListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PLUGIN_FURNITURE_CATALOG_FAMILY

public static final java.lang.String PLUGIN_FURNITURE_CATALOG_FAMILY

The name of .properties family files in plugin furniture catalog files.

See Also:

Constant Field Values

Constructor Detail

DefaultFurnitureCatalog

public DefaultFurnitureCatalog()

Creates a default furniture catalog read from resources in the package of this class.

DefaultFurnitureCatalog

public DefaultFurnitureCatalog(java.io.File furniturePluginFolder)

Creates a default furniture catalog read from resources and furniture plugin folder if furniturePluginFolder isn't null.

DefaultFurnitureCatalog

public DefaultFurnitureCatalog(UserPreferences preferences,
                               java.io.File furniturePluginFolder)

Creates a default furniture catalog read from resources and furniture plugin folder if furniturePluginFolder isn't null.

DefaultFurnitureCatalog

public DefaultFurnitureCatalog(UserPreferences preferences,
                               java.io.File[] furniturePluginFolders)

Creates a default furniture catalog read from resources and furniture plugin folders if furniturePluginFolders isn't null.

DefaultFurnitureCatalog

public DefaultFurnitureCatalog(java.net.URL[] pluginFurnitureCatalogUrls)

Creates a default furniture catalog read only from resources in the given URLs.

DefaultFurnitureCatalog

public DefaultFurnitureCatalog(java.net.URL[] pluginFurnitureCatalogUrls,
                               java.net.URL furnitureResourcesUrlBase)

Creates a default furniture catalog read only from resources in the given URLs or in the classpath if the security manager doesn't allow to create class loaders. Model and icon URLs will built from furnitureResourcesUrlBase if it isn't null.

Method Detail

getLibraries

public java.util.List<Library> getLibraries()

Returns the furniture libraries at initialization.

Since:

4.0

getAdditionalProperties

protected java.util.Map<java.lang.String,java.lang.String> getAdditionalProperties(java.util.ResourceBundle resource,
                                                                                   int index)

Returns the properties of the piece at the given index different from default properties.

getAdditionalContents

protected java.util.Map<java.lang.String,Content> getAdditionalContents(java.util.ResourceBundle resource,
                                                                        int index,
                                                                        java.net.URL furnitureCatalogUrl,
                                                                        java.net.URL furnitureResourcesUrlBase)

Returns the contents of the piece at the given index different from default properties.

isDefaultProperty

protected boolean isDefaultProperty(java.lang.String keyPrefix)

Returns true if the given parameter is the prefix of a default property used as an attribute of a piece of furniture.

readPieceOfFurniture

protected CatalogPieceOfFurniture readPieceOfFurniture(java.util.ResourceBundle resource,
                                                       int index,
                                                       java.net.URL furnitureCatalogUrl,
                                                       java.net.URL furnitureResourcesUrlBase)

Returns the piece of furniture at the given index of a localized resource bundle.

Parameters:

resource - a resource bundle

index - the index of the read piece

furnitureCatalogUrl - the URL from which piece resources will be loaded or null if it's read from current classpath.

furnitureResourcesUrlBase - the URL used as a base to build the URL to piece resources or null if it's read from current classpath or furnitureCatalogUrl

Returns:

the read piece of furniture or null if the piece at the given index doesn't exist.

Throws:

java.util.MissingResourceException - if mandatory keys are not defined.

readFurnitureCategory

protected FurnitureCategory readFurnitureCategory(java.util.ResourceBundle resource,
                                                  int index)

Returns the furniture category of a piece at the given index of a localized resource bundle.

Throws:

java.util.MissingResourceException - if mandatory keys are not defined.