mil.nga.geopackage.property.GeoPackageProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of geopackage-core Show documentation
Core functionality for GeoPackage implementations
The newest version!
package mil.nga.geopackage.property;

import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * GeoPackage property loader
 * 
 * @author osbornb
 */
public class GeoPackageProperties {

	/**
	 * Logger
	 */
	private static final Logger log = Logger
			.getLogger(GeoPackageProperties.class.getName());

	/**
	 * Properties
	 */
	private static Properties mProperties;

	/**
	 * Get a required property by key
	 * 
	 * @param key
	 *            key
	 * @return value
	 */
	public static String getProperty(String key) {
		return getProperty(key, true);
	}

	/**
	 * Get a property by key
	 * 
	 * @param key
	 *            key
	 * @param required
	 *            true if required
	 * @return value
	 */
	public static synchronized String getProperty(String key,
			boolean required) {
		if (mProperties == null) {
			mProperties = initializeConfigurationProperties();
		}
		String value = mProperties.getProperty(key);
		if (value == null && required) {
			throw new RuntimeException("Property not found: " + key);
		}
		return value;
	}

	/**
	 * Get a required property by property parts
	 * 
	 * @param properties
	 *            property parts
	 * @return value
	 * @since 4.0.0
	 */
	public static String getProperty(String... properties) {
		return getProperty(true, properties);
	}

	/**
	 * Get a property by property parts
	 * 
	 * @param required
	 *            true if required
	 * @param properties
	 *            property parts
	 * @return value
	 * @since 4.0.0
	 */
	public static String getProperty(boolean required, String... properties) {
		return getProperty(buildProperty(properties), required);
	}

	/**
	 * Get a required integer property by key
	 * 
	 * @param key
	 *            key
	 * @return integer value
	 */
	public static int getIntegerProperty(String key) {
		return getIntegerProperty(key, true);
	}

	/**
	 * Get an integer property by key
	 * 
	 * @param key
	 *            key
	 * @param required
	 *            true if required
	 * @return integer value
	 */
	public static Integer getIntegerProperty(String key, boolean required) {
		Integer value = null;
		String stringValue = getProperty(key, required);
		if (stringValue != null) {
			value = Integer.valueOf(stringValue);
		}
		return value;
	}

	/**
	 * Get a required integer property by property parts
	 * 
	 * @param properties
	 *            property parts
	 * @return integer value
	 * @since 4.0.0
	 */
	public static int getIntegerProperty(String... properties) {
		return getIntegerProperty(true, properties);
	}

	/**
	 * Get an integer property by property parts
	 * 
	 * @param required
	 *            true if required
	 * @param properties
	 *            property parts
	 * @return integer value
	 * @since 4.0.0
	 */
	public static Integer getIntegerProperty(boolean required,
			String... properties) {
		return getIntegerProperty(buildProperty(properties), required);
	}

	/**
	 * Get a required float by key
	 * 
	 * @param key
	 *            key
	 * @return float value
	 */
	public static float getFloatProperty(String key) {
		return getFloatProperty(key, true);
	}

	/**
	 * Get a float by key
	 * 
	 * @param key
	 *            key
	 * @param required
	 *            true if required
	 * @return float value
	 */
	public static Float getFloatProperty(String key, boolean required) {
		Float value = null;
		String stringValue = getProperty(key, required);
		if (stringValue != null) {
			value = Float.valueOf(stringValue);
		}
		return value;
	}

	/**
	 * Get a required float property by property parts
	 * 
	 * @param properties
	 *            property parts
	 * @return float value
	 * @since 4.0.0
	 */
	public static float getFloatProperty(String... properties) {
		return getFloatProperty(true, properties);
	}

	/**
	 * Get a float property by property parts
	 * 
	 * @param required
	 *            true if required
	 * @param properties
	 *            property parts
	 * @return float value
	 * @since 4.0.0
	 */
	public static Float getFloatProperty(boolean required,
			String... properties) {
		return getFloatProperty(buildProperty(properties), required);
	}

	/**
	 * Get a required boolean by key
	 * 
	 * @param key
	 *            key
	 * @return boolean value
	 */
	public static boolean getBooleanProperty(String key) {
		return getBooleanProperty(key, true);
	}

	/**
	 * Get a boolean by key
	 * 
	 * @param key
	 *            key
	 * @param required
	 *            true if required
	 * @return boolean value
	 */
	public static Boolean getBooleanProperty(String key, boolean required) {
		Boolean value = null;
		String stringValue = getProperty(key, required);
		if (stringValue != null) {
			value = Boolean.valueOf(stringValue);
		}
		return value;
	}

	/**
	 * Get a required boolean property by property parts
	 * 
	 * @param properties
	 *            property parts
	 * @return boolean value
	 * @since 4.0.0
	 */
	public static boolean getBooleanProperty(String... properties) {
		return getBooleanProperty(true, properties);
	}

	/**
	 * Get a boolean property by property parts
	 * 
	 * @param required
	 *            true if required
	 * @param properties
	 *            property parts
	 * @return boolean value
	 * @since 4.0.0
	 */
	public static Boolean getBooleanProperty(boolean required,
			String... properties) {
		return getBooleanProperty(buildProperty(properties), required);
	}

	/**
	 * Initialize the configuration properties
	 * 
	 * @return properties
	 */
	private static Properties initializeConfigurationProperties() {
		Properties properties = new Properties();

		InputStream in = GeoPackageProperties.class
				.getResourceAsStream("/" + PropertyConstants.PROPERTIES_FILE);
		if (in != null) {
			try {
				properties.load(in);
			} catch (Exception e) {
				log.log(Level.SEVERE, "Failed to load properties file: "
						+ PropertyConstants.PROPERTIES_FILE, e);
			} finally {
				try {
					in.close();
				} catch (IOException e) {
					log.log(Level.WARNING, "Failed to close properties file: "
							+ PropertyConstants.PROPERTIES_FILE, e);
				}
			}
		} else {
			log.log(Level.SEVERE, "Failed to load properties, file not found: "
					+ PropertyConstants.PROPERTIES_FILE);
		}

		return properties;
	}

	/**
	 * Build a combined property separated by
	 * {@link PropertyConstants#PROPERTY_DIVIDER}
	 * 
	 * @param properties
	 *            property parts
	 * 
	 * @return combined property
	 * @since 4.0.0
	 */
	public static String buildProperty(String... properties) {
		StringBuilder combined = new StringBuilder();
		for (String property : properties) {
			if (property != null) {
				if (combined.length() > 0) {
					combined.append(PropertyConstants.PROPERTY_DIVIDER);
				}
				combined.append(property);
			}
		}
		return combined.toString();
	}

}