SettingItemStore.java

/*
 *  Copyright 2012 Axel Winkler, Daniel Dunér
 * 
 *  This file is part of Daxplore Presenter.
 *
 *  Daxplore Presenter 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, either version 2.1 of the License, or
 *  (at your option) any later version.
 *
 *  Daxplore Presenter 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.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with Daxplore Presenter.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.daxplore.presenter.server.storage;

import java.util.Locale;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.jdo.JDOObjectNotFoundException;
import javax.jdo.PersistenceManager;
import javax.jdo.annotations.PersistenceCapable;
import javax.jdo.annotations.Persistent;
import javax.jdo.annotations.PrimaryKey;

import org.daxplore.presenter.server.throwable.BadRequestException;

/**
 * A representation of a StatDataItem and it's key that can be
 * persisted (stored) using a JDO {@link PersistenceManager}.
 * 
 * <p>This acts like an item in a hash table (represented by the
 * {@linkplain PersistenceManager}), making it possible to fetch data items
 * with a specific key.</p>
 */
@PersistenceCapable
public class SettingItemStore {
	private static Logger logger = Logger.getLogger(SettingItemStore.class.getName());
	@Persistent private String prefix;
	@PrimaryKey private String key;
	@Persistent private String value;

	/**
	 * Creates a new settings item to hold a setting uploaded by an administrator
	 * using the admin console.
	 * 
	 * <p>The key should be on the format "prefix#filename[_locale]/propertyname" The prefix defines
	 * which presenter the setting belongs to, the name is the name of the
	 * setting and locale is a Locale.toLanguageTag.</p>
	 * 
	 * @param prefix
	 *            the prefix that this item belongs to
	 * @param key
	 *            a key on the format "prefix#filename[_locale]/propertyname"
	 * @param value
	 *            the value of the setting
	 */
	public SettingItemStore(String key, String value) {
		this.key = key;
		this.value = value;
		this.prefix = key.substring(0, key.indexOf('#'));
	}

	/**
	 * Get the key.
	 * 
	 * @return the key
	 */
	public String getKey() {
		return key;
	}

	public String getValue() {
		return value;
	}
	
	public void setValue(String value) {
		this.value = value;
	}
	
	public static String getProperty(PersistenceManager pm, String prefix,
			String fileName, String propertyName) {
		String statStoreKey = prefix + "#" + fileName + "/" + propertyName;
		try {
			return pm.getObjectById(SettingItemStore.class, statStoreKey).getValue();
		} catch (JDOObjectNotFoundException e) {
			logger.log(Level.WARNING, "Property '" + statStoreKey + "' not found");
			return "";
		}
	}
	
	public static String getLocalizedProperty(PersistenceManager pm, String prefix,
			String fileName, Locale locale, String propertyName) throws BadRequestException {
		String statStoreKey = prefix + "#" + fileName + "_" + locale.toLanguageTag() + "/" + propertyName;
		try {
			return pm.getObjectById(SettingItemStore.class, statStoreKey).getValue();
		} catch (JDOObjectNotFoundException e) {
			throw new BadRequestException("Could not read localized property '" + statStoreKey + "'", e);
		}
	}
}