/**
* Copyright (C) 2009 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.component.factory.source;
import java.util.LinkedHashMap;
import java.util.Map;
import net.sf.ehcache.CacheManager;
import org.joda.beans.BeanBuilder;
import org.joda.beans.BeanDefinition;
import org.joda.beans.JodaBeanUtils;
import org.joda.beans.MetaProperty;
import org.joda.beans.Property;
import org.joda.beans.PropertyDefinition;
import org.joda.beans.impl.direct.DirectBeanBuilder;
import org.joda.beans.impl.direct.DirectMetaProperty;
import org.joda.beans.impl.direct.DirectMetaPropertyMap;
import com.opengamma.component.ComponentInfo;
import com.opengamma.component.ComponentRepository;
import com.opengamma.component.factory.AbstractComponentFactory;
import com.opengamma.component.factory.ComponentInfoAttributes;
import com.opengamma.core.config.ConfigSource;
import com.opengamma.core.historicaltimeseries.HistoricalTimeSeriesSource;
import com.opengamma.core.historicaltimeseries.impl.DataHistoricalTimeSeriesSourceResource;
import com.opengamma.core.historicaltimeseries.impl.EHCachingHistoricalTimeSeriesSource;
import com.opengamma.core.historicaltimeseries.impl.RemoteHistoricalTimeSeriesSource;
import com.opengamma.master.historicaltimeseries.HistoricalTimeSeriesMaster;
import com.opengamma.master.historicaltimeseries.HistoricalTimeSeriesResolver;
import com.opengamma.master.historicaltimeseries.HistoricalTimeSeriesSelector;
import com.opengamma.master.historicaltimeseries.impl.DataHistoricalTimeSeriesResolverResource;
import com.opengamma.master.historicaltimeseries.impl.DefaultHistoricalTimeSeriesResolver;
import com.opengamma.master.historicaltimeseries.impl.DefaultHistoricalTimeSeriesSelector;
import com.opengamma.master.historicaltimeseries.impl.EHCachingHistoricalTimeSeriesResolver;
import com.opengamma.master.historicaltimeseries.impl.MasterHistoricalTimeSeriesSource;
import com.opengamma.master.historicaltimeseries.impl.RemoteHistoricalTimeSeriesResolver;
import com.opengamma.util.fudgemsg.OpenGammaFudgeContext;
/**
* Component factory providing the {@code HistoricalTimeSeriesSource}.
*/
@BeanDefinition
public class HistoricalTimeSeriesSourceComponentFactory extends AbstractComponentFactory {
/**
* The classifier that the factory should publish under.
*/
@PropertyDefinition(validate = "notNull")
private String _classifier;
/**
* The flag determining whether the component should be published by REST (default true).
*/
@PropertyDefinition
private boolean _publishRest = true;
/**
* The cache manager.
*/
@PropertyDefinition
private CacheManager _cacheManager;
/**
* The underlying hts master.
*/
@PropertyDefinition(validate = "notNull")
private HistoricalTimeSeriesMaster _historicalTimeSeriesMaster;
/**
* The config source.
*/
@PropertyDefinition(validate = "notNull")
private ConfigSource _configSource;
//-------------------------------------------------------------------------
/**
* Initializes the HTS source, setting up component information and REST. Override using {@link #createResolver(ComponentRepository)} and
* {@link #createSource(ComponentRepository, HistoricalTimeSeriesResolver)}.
*
* @param repo the component repository, not null
* @param configuration the remaining configuration, not null
*/
@Override
public void init(ComponentRepository repo, LinkedHashMap<String, String> configuration) {
HistoricalTimeSeriesResolver resolver = createResolver(repo);
if (getCacheManager() != null) {
resolver = createCachedResolver(resolver);
}
ComponentInfo infoResolver = new ComponentInfo(HistoricalTimeSeriesResolver.class, getClassifier());
infoResolver.addAttribute(ComponentInfoAttributes.LEVEL, 1);
infoResolver.addAttribute(ComponentInfoAttributes.REMOTE_CLIENT_JAVA, RemoteHistoricalTimeSeriesResolver.class);
repo.registerComponent(infoResolver, resolver);
HistoricalTimeSeriesSource source = createSource(repo, resolver);
ComponentInfo infoSource = new ComponentInfo(HistoricalTimeSeriesSource.class, getClassifier());
infoSource.addAttribute(ComponentInfoAttributes.LEVEL, 1);
infoSource.addAttribute(ComponentInfoAttributes.REMOTE_CLIENT_JAVA, RemoteHistoricalTimeSeriesSource.class);
repo.registerComponent(infoSource, source);
if (isPublishRest()) {
repo.getRestComponents().publish(infoResolver, new DataHistoricalTimeSeriesResolverResource(resolver, OpenGammaFudgeContext.getInstance()));
repo.getRestComponents().publish(infoSource, new DataHistoricalTimeSeriesSourceResource(source));
}
}
/**
* Creates the HTS provider without registering it.
*
* @param repo the component repository, only used to register secondary items like lifecycle, not null
* @return the provider, not null
*/
protected HistoricalTimeSeriesResolver createResolver(ComponentRepository repo) {
HistoricalTimeSeriesSelector selector = new DefaultHistoricalTimeSeriesSelector(getConfigSource());
return new DefaultHistoricalTimeSeriesResolver(selector, getHistoricalTimeSeriesMaster());
}
protected HistoricalTimeSeriesResolver createCachedResolver(HistoricalTimeSeriesResolver resolver) {
return new EHCachingHistoricalTimeSeriesResolver(resolver, getCacheManager());
}
/**
* Creates the HTS source without registering it.
* <p>
* This calls {@link #createSourcePreCaching(ComponentRepository, HistoricalTimeSeriesResolver)}.
*
* @param repo the component repository, only used to register secondary items like lifecycle, not null
* @param resolver the resolver, not null
* @return the source, not null
*/
protected HistoricalTimeSeriesSource createSource(ComponentRepository repo, HistoricalTimeSeriesResolver resolver) {
HistoricalTimeSeriesSource source = createSourcePreCaching(repo, resolver);
if (getCacheManager() != null) {
source = new EHCachingHistoricalTimeSeriesSource(source, getCacheManager());
}
return source;
}
/**
* Creates the HTS source without registering it before caching.
*
* @param repo the component repository, only used to register secondary items like lifecycle, not null
* @param resolver the resolver, not null
* @return the source, not null
*/
protected HistoricalTimeSeriesSource createSourcePreCaching(ComponentRepository repo, HistoricalTimeSeriesResolver resolver) {
return new MasterHistoricalTimeSeriesSource(getHistoricalTimeSeriesMaster(), resolver);
}
//------------------------- AUTOGENERATED START -------------------------
///CLOVER:OFF
/**
* The meta-bean for {@code HistoricalTimeSeriesSourceComponentFactory}.
* @return the meta-bean, not null
*/
public static HistoricalTimeSeriesSourceComponentFactory.Meta meta() {
return HistoricalTimeSeriesSourceComponentFactory.Meta.INSTANCE;
}
static {
JodaBeanUtils.registerMetaBean(HistoricalTimeSeriesSourceComponentFactory.Meta.INSTANCE);
}
@Override
public HistoricalTimeSeriesSourceComponentFactory.Meta metaBean() {
return HistoricalTimeSeriesSourceComponentFactory.Meta.INSTANCE;
}
@Override
protected Object propertyGet(String propertyName, boolean quiet) {
switch (propertyName.hashCode()) {
case -281470431: // classifier
return getClassifier();
case -614707837: // publishRest
return isPublishRest();
case -1452875317: // cacheManager
return getCacheManager();
case 173967376: // historicalTimeSeriesMaster
return getHistoricalTimeSeriesMaster();
case 195157501: // configSource
return getConfigSource();
}
return super.propertyGet(propertyName, quiet);
}
@Override
protected void propertySet(String propertyName, Object newValue, boolean quiet) {
switch (propertyName.hashCode()) {
case -281470431: // classifier
setClassifier((String) newValue);
return;
case -614707837: // publishRest
setPublishRest((Boolean) newValue);
return;
case -1452875317: // cacheManager
setCacheManager((CacheManager) newValue);
return;
case 173967376: // historicalTimeSeriesMaster
setHistoricalTimeSeriesMaster((HistoricalTimeSeriesMaster) newValue);
return;
case 195157501: // configSource
setConfigSource((ConfigSource) newValue);
return;
}
super.propertySet(propertyName, newValue, quiet);
}
@Override
protected void validate() {
JodaBeanUtils.notNull(_classifier, "classifier");
JodaBeanUtils.notNull(_historicalTimeSeriesMaster, "historicalTimeSeriesMaster");
JodaBeanUtils.notNull(_configSource, "configSource");
super.validate();
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj != null && obj.getClass() == this.getClass()) {
HistoricalTimeSeriesSourceComponentFactory other = (HistoricalTimeSeriesSourceComponentFactory) obj;
return JodaBeanUtils.equal(getClassifier(), other.getClassifier()) &&
JodaBeanUtils.equal(isPublishRest(), other.isPublishRest()) &&
JodaBeanUtils.equal(getCacheManager(), other.getCacheManager()) &&
JodaBeanUtils.equal(getHistoricalTimeSeriesMaster(), other.getHistoricalTimeSeriesMaster()) &&
JodaBeanUtils.equal(getConfigSource(), other.getConfigSource()) &&
super.equals(obj);
}
return false;
}
@Override
public int hashCode() {
int hash = 7;
hash += hash * 31 + JodaBeanUtils.hashCode(getClassifier());
hash += hash * 31 + JodaBeanUtils.hashCode(isPublishRest());
hash += hash * 31 + JodaBeanUtils.hashCode(getCacheManager());
hash += hash * 31 + JodaBeanUtils.hashCode(getHistoricalTimeSeriesMaster());
hash += hash * 31 + JodaBeanUtils.hashCode(getConfigSource());
return hash ^ super.hashCode();
}
//-----------------------------------------------------------------------
/**
* Gets the classifier that the factory should publish under.
* @return the value of the property, not null
*/
public String getClassifier() {
return _classifier;
}
/**
* Sets the classifier that the factory should publish under.
* @param classifier the new value of the property, not null
*/
public void setClassifier(String classifier) {
JodaBeanUtils.notNull(classifier, "classifier");
this._classifier = classifier;
}
/**
* Gets the the {@code classifier} property.
* @return the property, not null
*/
public final Property<String> classifier() {
return metaBean().classifier().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the flag determining whether the component should be published by REST (default true).
* @return the value of the property
*/
public boolean isPublishRest() {
return _publishRest;
}
/**
* Sets the flag determining whether the component should be published by REST (default true).
* @param publishRest the new value of the property
*/
public void setPublishRest(boolean publishRest) {
this._publishRest = publishRest;
}
/**
* Gets the the {@code publishRest} property.
* @return the property, not null
*/
public final Property<Boolean> publishRest() {
return metaBean().publishRest().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the cache manager.
* @return the value of the property
*/
public CacheManager getCacheManager() {
return _cacheManager;
}
/**
* Sets the cache manager.
* @param cacheManager the new value of the property
*/
public void setCacheManager(CacheManager cacheManager) {
this._cacheManager = cacheManager;
}
/**
* Gets the the {@code cacheManager} property.
* @return the property, not null
*/
public final Property<CacheManager> cacheManager() {
return metaBean().cacheManager().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the underlying hts master.
* @return the value of the property, not null
*/
public HistoricalTimeSeriesMaster getHistoricalTimeSeriesMaster() {
return _historicalTimeSeriesMaster;
}
/**
* Sets the underlying hts master.
* @param historicalTimeSeriesMaster the new value of the property, not null
*/
public void setHistoricalTimeSeriesMaster(HistoricalTimeSeriesMaster historicalTimeSeriesMaster) {
JodaBeanUtils.notNull(historicalTimeSeriesMaster, "historicalTimeSeriesMaster");
this._historicalTimeSeriesMaster = historicalTimeSeriesMaster;
}
/**
* Gets the the {@code historicalTimeSeriesMaster} property.
* @return the property, not null
*/
public final Property<HistoricalTimeSeriesMaster> historicalTimeSeriesMaster() {
return metaBean().historicalTimeSeriesMaster().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the config source.
* @return the value of the property, not null
*/
public ConfigSource getConfigSource() {
return _configSource;
}
/**
* Sets the config source.
* @param configSource the new value of the property, not null
*/
public void setConfigSource(ConfigSource configSource) {
JodaBeanUtils.notNull(configSource, "configSource");
this._configSource = configSource;
}
/**
* Gets the the {@code configSource} property.
* @return the property, not null
*/
public final Property<ConfigSource> configSource() {
return metaBean().configSource().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* The meta-bean for {@code HistoricalTimeSeriesSourceComponentFactory}.
*/
public static class Meta extends AbstractComponentFactory.Meta {
/**
* The singleton instance of the meta-bean.
*/
static final Meta INSTANCE = new Meta();
/**
* The meta-property for the {@code classifier} property.
*/
private final MetaProperty<String> _classifier = DirectMetaProperty.ofReadWrite(
this, "classifier", HistoricalTimeSeriesSourceComponentFactory.class, String.class);
/**
* The meta-property for the {@code publishRest} property.
*/
private final MetaProperty<Boolean> _publishRest = DirectMetaProperty.ofReadWrite(
this, "publishRest", HistoricalTimeSeriesSourceComponentFactory.class, Boolean.TYPE);
/**
* The meta-property for the {@code cacheManager} property.
*/
private final MetaProperty<CacheManager> _cacheManager = DirectMetaProperty.ofReadWrite(
this, "cacheManager", HistoricalTimeSeriesSourceComponentFactory.class, CacheManager.class);
/**
* The meta-property for the {@code historicalTimeSeriesMaster} property.
*/
private final MetaProperty<HistoricalTimeSeriesMaster> _historicalTimeSeriesMaster = DirectMetaProperty.ofReadWrite(
this, "historicalTimeSeriesMaster", HistoricalTimeSeriesSourceComponentFactory.class, HistoricalTimeSeriesMaster.class);
/**
* The meta-property for the {@code configSource} property.
*/
private final MetaProperty<ConfigSource> _configSource = DirectMetaProperty.ofReadWrite(
this, "configSource", HistoricalTimeSeriesSourceComponentFactory.class, ConfigSource.class);
/**
* The meta-properties.
*/
private final Map<String, MetaProperty<?>> _metaPropertyMap$ = new DirectMetaPropertyMap(
this, (DirectMetaPropertyMap) super.metaPropertyMap(),
"classifier",
"publishRest",
"cacheManager",
"historicalTimeSeriesMaster",
"configSource");
/**
* Restricted constructor.
*/
protected Meta() {
}
@Override
protected MetaProperty<?> metaPropertyGet(String propertyName) {
switch (propertyName.hashCode()) {
case -281470431: // classifier
return _classifier;
case -614707837: // publishRest
return _publishRest;
case -1452875317: // cacheManager
return _cacheManager;
case 173967376: // historicalTimeSeriesMaster
return _historicalTimeSeriesMaster;
case 195157501: // configSource
return _configSource;
}
return super.metaPropertyGet(propertyName);
}
@Override
public BeanBuilder<? extends HistoricalTimeSeriesSourceComponentFactory> builder() {
return new DirectBeanBuilder<HistoricalTimeSeriesSourceComponentFactory>(new HistoricalTimeSeriesSourceComponentFactory());
}
@Override
public Class<? extends HistoricalTimeSeriesSourceComponentFactory> beanType() {
return HistoricalTimeSeriesSourceComponentFactory.class;
}
@Override
public Map<String, MetaProperty<?>> metaPropertyMap() {
return _metaPropertyMap$;
}
//-----------------------------------------------------------------------
/**
* The meta-property for the {@code classifier} property.
* @return the meta-property, not null
*/
public final MetaProperty<String> classifier() {
return _classifier;
}
/**
* The meta-property for the {@code publishRest} property.
* @return the meta-property, not null
*/
public final MetaProperty<Boolean> publishRest() {
return _publishRest;
}
/**
* The meta-property for the {@code cacheManager} property.
* @return the meta-property, not null
*/
public final MetaProperty<CacheManager> cacheManager() {
return _cacheManager;
}
/**
* The meta-property for the {@code historicalTimeSeriesMaster} property.
* @return the meta-property, not null
*/
public final MetaProperty<HistoricalTimeSeriesMaster> historicalTimeSeriesMaster() {
return _historicalTimeSeriesMaster;
}
/**
* The meta-property for the {@code configSource} property.
* @return the meta-property, not null
*/
public final MetaProperty<ConfigSource> configSource() {
return _configSource;
}
}
///CLOVER:ON
//-------------------------- AUTOGENERATED END --------------------------
}