/**
* Copyright (C) 2009 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.master.config;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.joda.beans.BeanBuilder;
import org.joda.beans.BeanDefinition;
import org.joda.beans.JodaBeanUtils;
import org.joda.beans.MetaProperty;
import org.joda.beans.impl.direct.DirectBeanBuilder;
import org.joda.beans.impl.direct.DirectMetaPropertyMap;
import com.opengamma.OpenGammaRuntimeException;
import com.opengamma.core.config.impl.ConfigItem;
import com.opengamma.master.AbstractHistoryResult;
import com.opengamma.util.PublicSPI;
import com.sun.jersey.api.client.GenericType;
/**
* Result providing the history of a piece of configuration.
* <p>
* The returned documents may be a mixture of versions and corrections.
* The document instant fields are used to identify which are which.
* See {@link ConfigHistoryRequest} for more details.
*
* @param <T> the type of the underlying config
*/
@PublicSPI
@BeanDefinition
public class ConfigHistoryResult<T> extends AbstractHistoryResult<ConfigDocument> {
/**
* The generic type token.
*/
private final GenericType<ConfigItem<T>> _gt = new GenericType<ConfigItem<T>>() { };
/**
* Creates an instance.
*/
public ConfigHistoryResult() {
}
/**
* Creates an instance from a collection of documents.
*
* @param coll the collection of documents to add, not null
*/
public ConfigHistoryResult(Collection<ConfigDocument> coll) {
super(coll);
}
//-------------------------------------------------------------------------
/**
* Gets the returned configuration values from within the documents.
*
* @return the configuration values, not null
*/
@SuppressWarnings("unchecked")
public List<ConfigItem<T>> getValues() {
List<ConfigItem<T>> result = new ArrayList<ConfigItem<T>>();
if (getDocuments() != null) {
for (ConfigDocument doc : getDocuments()) {
if (_gt.getRawClass().isAssignableFrom(doc.getConfig().getType())) {
result.add((ConfigItem<T>) doc.getConfig());
}
}
}
return result;
}
/**
* Gets the first configuration document value, or null if no documents.
*
* @return the first configuration value, null if none
*/
@SuppressWarnings("unchecked")
public ConfigItem<T> getFirstValue() {
if (getDocuments().size() > 0) {
ConfigItem<?> firstItem = getDocuments().get(0).getConfig();
if (_gt.getRawClass().isAssignableFrom(firstItem.getType())) {
return (ConfigItem<T>) firstItem;
}
}
return null;
}
/**
* Gets the single result expected from a query.
* <p>
* This throws an exception if more than 1 result is actually available.
* Thus, this method implies an assumption about uniqueness of the queried config.
*
* @return the matching config, not null
* @throws IllegalStateException if no config was found
*/
public ConfigItem<T> getSingleValue() {
if (getDocuments().size() != 1) {
throw new OpenGammaRuntimeException("Expecting zero or single resulting match, and was " + getDocuments().size());
} else {
return getFirstValue();
}
}
//------------------------- AUTOGENERATED START -------------------------
///CLOVER:OFF
/**
* The meta-bean for {@code ConfigHistoryResult}.
* @return the meta-bean, not null
*/
@SuppressWarnings("rawtypes")
public static ConfigHistoryResult.Meta meta() {
return ConfigHistoryResult.Meta.INSTANCE;
}
/**
* The meta-bean for {@code ConfigHistoryResult}.
* @param <R> the bean's generic type
* @param cls the bean's generic type
* @return the meta-bean, not null
*/
@SuppressWarnings("unchecked")
public static <R> ConfigHistoryResult.Meta<R> metaConfigHistoryResult(Class<R> cls) {
return ConfigHistoryResult.Meta.INSTANCE;
}
static {
JodaBeanUtils.registerMetaBean(ConfigHistoryResult.Meta.INSTANCE);
}
@SuppressWarnings("unchecked")
@Override
public ConfigHistoryResult.Meta<T> metaBean() {
return ConfigHistoryResult.Meta.INSTANCE;
}
//-----------------------------------------------------------------------
@Override
public ConfigHistoryResult<T> clone() {
return JodaBeanUtils.cloneAlways(this);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj != null && obj.getClass() == this.getClass()) {
return super.equals(obj);
}
return false;
}
@Override
public int hashCode() {
int hash = 7;
return hash ^ super.hashCode();
}
@Override
public String toString() {
StringBuilder buf = new StringBuilder(32);
buf.append("ConfigHistoryResult{");
int len = buf.length();
toString(buf);
if (buf.length() > len) {
buf.setLength(buf.length() - 2);
}
buf.append('}');
return buf.toString();
}
@Override
protected void toString(StringBuilder buf) {
super.toString(buf);
}
//-----------------------------------------------------------------------
/**
* The meta-bean for {@code ConfigHistoryResult}.
* @param <T> the type
*/
public static class Meta<T> extends AbstractHistoryResult.Meta<ConfigDocument> {
/**
* The singleton instance of the meta-bean.
*/
@SuppressWarnings("rawtypes")
static final Meta INSTANCE = new Meta();
/**
* The meta-properties.
*/
private final Map<String, MetaProperty<?>> _metaPropertyMap$ = new DirectMetaPropertyMap(
this, (DirectMetaPropertyMap) super.metaPropertyMap());
/**
* Restricted constructor.
*/
protected Meta() {
}
@Override
public BeanBuilder<? extends ConfigHistoryResult<T>> builder() {
return new DirectBeanBuilder<ConfigHistoryResult<T>>(new ConfigHistoryResult<T>());
}
@SuppressWarnings({"unchecked", "rawtypes" })
@Override
public Class<? extends ConfigHistoryResult<T>> beanType() {
return (Class) ConfigHistoryResult.class;
}
@Override
public Map<String, MetaProperty<?>> metaPropertyMap() {
return _metaPropertyMap$;
}
//-----------------------------------------------------------------------
}
///CLOVER:ON
//-------------------------- AUTOGENERATED END --------------------------
}