/**
* Copyright (C) 2009 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.master.region;
import java.io.Serializable;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.joda.beans.Bean;
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.DirectBean;
import org.joda.beans.impl.direct.DirectBeanBuilder;
import org.joda.beans.impl.direct.DirectMetaBean;
import org.joda.beans.impl.direct.DirectMetaProperty;
import org.joda.beans.impl.direct.DirectMetaPropertyMap;
import org.joda.beans.impl.flexi.FlexiBean;
import org.threeten.bp.ZoneId;
import com.opengamma.core.id.ExternalSchemes;
import com.opengamma.core.region.Region;
import com.opengamma.core.region.RegionClassification;
import com.opengamma.id.ExternalId;
import com.opengamma.id.ExternalIdBundle;
import com.opengamma.id.UniqueId;
import com.opengamma.util.ArgumentChecker;
import com.opengamma.util.PublicSPI;
import com.opengamma.util.i18n.Country;
import com.opengamma.util.money.Currency;
/**
* The manageable implementation of a region.
* <p>
* This implementation is used by the region master to store and manipulate the data.
*/
@PublicSPI
@BeanDefinition
public class ManageableRegion extends DirectBean implements Region, Serializable {
/** Serialization version. */
private static final long serialVersionUID = 1L;
/**
* The unique identifier of the region.
* This must be null when adding to a master and not null when retrieved from a master.
*/
@PropertyDefinition
private UniqueId _uniqueId;
/**
* The bundle of identifiers that define the region.
* This will include the country, currency and time-zone.
* This field must not be null for the object to be valid.
*/
@PropertyDefinition
private ExternalIdBundle _externalIdBundle = ExternalIdBundle.EMPTY;
/**
* The classification of the region.
* This field must not be null for the object to be valid.
*/
@PropertyDefinition
private RegionClassification _classification;
/**
* The unique identifiers of the parent regions.
* For example, a country might be a member of the World, UN, European Union and NATO.
*/
@PropertyDefinition(set = "setClearAddAll")
private Set<UniqueId> _parentRegionIds = new HashSet<UniqueId>();
/**
* The short descriptive name for the region.
* This field must not be null for the object to be valid.
*/
@PropertyDefinition
private String _name;
/**
* The full descriptive name for the region.
*/
@PropertyDefinition
private String _fullName;
/**
* The extensible data store for additional information, not null.
* Applications may store additional region based information here.
*/
@PropertyDefinition
private final FlexiBean _data = new FlexiBean();
/**
* Creates an instance.
*/
public ManageableRegion() {
}
/**
* Create an instance from another region instance.
* <p>
* This copies the specified region creating an independent copy.
*
* @param region the region to copy, not null
*/
public ManageableRegion(final Region region) {
ArgumentChecker.notNull(region, "region");
setUniqueId(region.getUniqueId());
setClassification(region.getClassification());
setParentRegionIds(region.getParentRegionIds());
setName(region.getName());
setFullName(region.getFullName());
setExternalIdBundle(region.getExternalIdBundle());
setData(region.getData());
}
//-------------------------------------------------------------------------
/**
* Adds an external identifier to the bundle representing this region.
*
* @param identifier the identifier to add, not null
*/
public void addExternalId(ExternalId identifier) {
setExternalIdBundle(getExternalIdBundle().withExternalId(identifier));
}
//-------------------------------------------------------------------------
/**
* Gets the country.
* @return the value of the property
*/
public Country getCountry() {
String code = _externalIdBundle.getValue(ExternalSchemes.ISO_COUNTRY_ALPHA2);
return (code != null ? Country.of(code) : null);
}
/**
* Sets the country, stored in the identifier set.
*
* @param country the country to set, null to remove any defined country
*/
public void setCountry(Country country) {
setExternalIdBundle(getExternalIdBundle().withoutScheme(ExternalSchemes.ISO_CURRENCY_ALPHA3));
if (country != null) {
addExternalId(ExternalSchemes.countryRegionId(country));
}
}
//-------------------------------------------------------------------------
/**
* Gets the currency.
* @return the value of the property
*/
public Currency getCurrency() {
String code = _externalIdBundle.getValue(ExternalSchemes.ISO_CURRENCY_ALPHA3);
return (code != null ? Currency.of(code) : null);
}
/**
* Sets the currency, stored in the identifier set.
*
* @param currency the currency to set, null to remove any currency
*/
public void setCurrency(Currency currency) {
setExternalIdBundle(getExternalIdBundle().withoutScheme(ExternalSchemes.ISO_CURRENCY_ALPHA3));
if (currency != null) {
addExternalId(ExternalSchemes.currencyRegionId(currency));
}
}
//-------------------------------------------------------------------------
/**
* Gets the time-zone.
* For larger regions, there can be multiple time-zones, so this is only reliable
* for municipalities.
* @return the value of the property
*/
public ZoneId getTimeZone() {
String id = _externalIdBundle.getValue(ExternalSchemes.TZDB_TIME_ZONE);
return (id != null ? ZoneId.of(id) : null);
}
/**
* Sets the time-zone, stored in the identifier set.
*
* @param timeZone the time-zone to set, null to remove any time-zone
*/
public void setTimeZone(ZoneId timeZone) {
setExternalIdBundle(getExternalIdBundle().withoutScheme(ExternalSchemes.TZDB_TIME_ZONE));
if (timeZone != null) {
addExternalId(ExternalSchemes.timeZoneRegionId(timeZone));
}
}
//------------------------- AUTOGENERATED START -------------------------
///CLOVER:OFF
/**
* The meta-bean for {@code ManageableRegion}.
* @return the meta-bean, not null
*/
public static ManageableRegion.Meta meta() {
return ManageableRegion.Meta.INSTANCE;
}
static {
JodaBeanUtils.registerMetaBean(ManageableRegion.Meta.INSTANCE);
}
@Override
public ManageableRegion.Meta metaBean() {
return ManageableRegion.Meta.INSTANCE;
}
//-----------------------------------------------------------------------
/**
* Gets the unique identifier of the region.
* This must be null when adding to a master and not null when retrieved from a master.
* @return the value of the property
*/
public UniqueId getUniqueId() {
return _uniqueId;
}
/**
* Sets the unique identifier of the region.
* This must be null when adding to a master and not null when retrieved from a master.
* @param uniqueId the new value of the property
*/
public void setUniqueId(UniqueId uniqueId) {
this._uniqueId = uniqueId;
}
/**
* Gets the the {@code uniqueId} property.
* This must be null when adding to a master and not null when retrieved from a master.
* @return the property, not null
*/
public final Property<UniqueId> uniqueId() {
return metaBean().uniqueId().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the bundle of identifiers that define the region.
* This will include the country, currency and time-zone.
* This field must not be null for the object to be valid.
* @return the value of the property
*/
public ExternalIdBundle getExternalIdBundle() {
return _externalIdBundle;
}
/**
* Sets the bundle of identifiers that define the region.
* This will include the country, currency and time-zone.
* This field must not be null for the object to be valid.
* @param externalIdBundle the new value of the property
*/
public void setExternalIdBundle(ExternalIdBundle externalIdBundle) {
this._externalIdBundle = externalIdBundle;
}
/**
* Gets the the {@code externalIdBundle} property.
* This will include the country, currency and time-zone.
* This field must not be null for the object to be valid.
* @return the property, not null
*/
public final Property<ExternalIdBundle> externalIdBundle() {
return metaBean().externalIdBundle().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the classification of the region.
* This field must not be null for the object to be valid.
* @return the value of the property
*/
public RegionClassification getClassification() {
return _classification;
}
/**
* Sets the classification of the region.
* This field must not be null for the object to be valid.
* @param classification the new value of the property
*/
public void setClassification(RegionClassification classification) {
this._classification = classification;
}
/**
* Gets the the {@code classification} property.
* This field must not be null for the object to be valid.
* @return the property, not null
*/
public final Property<RegionClassification> classification() {
return metaBean().classification().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the unique identifiers of the parent regions.
* For example, a country might be a member of the World, UN, European Union and NATO.
* @return the value of the property
*/
public Set<UniqueId> getParentRegionIds() {
return _parentRegionIds;
}
/**
* Sets the unique identifiers of the parent regions.
* For example, a country might be a member of the World, UN, European Union and NATO.
* @param parentRegionIds the new value of the property
*/
public void setParentRegionIds(Set<UniqueId> parentRegionIds) {
this._parentRegionIds.clear();
this._parentRegionIds.addAll(parentRegionIds);
}
/**
* Gets the the {@code parentRegionIds} property.
* For example, a country might be a member of the World, UN, European Union and NATO.
* @return the property, not null
*/
public final Property<Set<UniqueId>> parentRegionIds() {
return metaBean().parentRegionIds().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the short descriptive name for the region.
* This field must not be null for the object to be valid.
* @return the value of the property
*/
public String getName() {
return _name;
}
/**
* Sets the short descriptive name for the region.
* This field must not be null for the object to be valid.
* @param name the new value of the property
*/
public void setName(String name) {
this._name = name;
}
/**
* Gets the the {@code name} property.
* This field must not be null for the object to be valid.
* @return the property, not null
*/
public final Property<String> name() {
return metaBean().name().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the full descriptive name for the region.
* @return the value of the property
*/
public String getFullName() {
return _fullName;
}
/**
* Sets the full descriptive name for the region.
* @param fullName the new value of the property
*/
public void setFullName(String fullName) {
this._fullName = fullName;
}
/**
* Gets the the {@code fullName} property.
* @return the property, not null
*/
public final Property<String> fullName() {
return metaBean().fullName().createProperty(this);
}
//-----------------------------------------------------------------------
/**
* Gets the extensible data store for additional information, not null.
* Applications may store additional region based information here.
* @return the value of the property, not null
*/
public FlexiBean getData() {
return _data;
}
/**
* Sets the extensible data store for additional information, not null.
* Applications may store additional region based information here.
* @param data the new value of the property, not null
*/
public void setData(FlexiBean data) {
JodaBeanUtils.notNull(data, "data");
this._data.clear();
this._data.putAll(data);
}
/**
* Gets the the {@code data} property.
* Applications may store additional region based information here.
* @return the property, not null
*/
public final Property<FlexiBean> data() {
return metaBean().data().createProperty(this);
}
//-----------------------------------------------------------------------
@Override
public ManageableRegion clone() {
return JodaBeanUtils.cloneAlways(this);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj != null && obj.getClass() == this.getClass()) {
ManageableRegion other = (ManageableRegion) obj;
return JodaBeanUtils.equal(getUniqueId(), other.getUniqueId()) &&
JodaBeanUtils.equal(getExternalIdBundle(), other.getExternalIdBundle()) &&
JodaBeanUtils.equal(getClassification(), other.getClassification()) &&
JodaBeanUtils.equal(getParentRegionIds(), other.getParentRegionIds()) &&
JodaBeanUtils.equal(getName(), other.getName()) &&
JodaBeanUtils.equal(getFullName(), other.getFullName()) &&
JodaBeanUtils.equal(getData(), other.getData());
}
return false;
}
@Override
public int hashCode() {
int hash = getClass().hashCode();
hash = hash * 31 + JodaBeanUtils.hashCode(getUniqueId());
hash = hash * 31 + JodaBeanUtils.hashCode(getExternalIdBundle());
hash = hash * 31 + JodaBeanUtils.hashCode(getClassification());
hash = hash * 31 + JodaBeanUtils.hashCode(getParentRegionIds());
hash = hash * 31 + JodaBeanUtils.hashCode(getName());
hash = hash * 31 + JodaBeanUtils.hashCode(getFullName());
hash = hash * 31 + JodaBeanUtils.hashCode(getData());
return hash;
}
@Override
public String toString() {
StringBuilder buf = new StringBuilder(256);
buf.append("ManageableRegion{");
int len = buf.length();
toString(buf);
if (buf.length() > len) {
buf.setLength(buf.length() - 2);
}
buf.append('}');
return buf.toString();
}
protected void toString(StringBuilder buf) {
buf.append("uniqueId").append('=').append(JodaBeanUtils.toString(getUniqueId())).append(',').append(' ');
buf.append("externalIdBundle").append('=').append(JodaBeanUtils.toString(getExternalIdBundle())).append(',').append(' ');
buf.append("classification").append('=').append(JodaBeanUtils.toString(getClassification())).append(',').append(' ');
buf.append("parentRegionIds").append('=').append(JodaBeanUtils.toString(getParentRegionIds())).append(',').append(' ');
buf.append("name").append('=').append(JodaBeanUtils.toString(getName())).append(',').append(' ');
buf.append("fullName").append('=').append(JodaBeanUtils.toString(getFullName())).append(',').append(' ');
buf.append("data").append('=').append(JodaBeanUtils.toString(getData())).append(',').append(' ');
}
//-----------------------------------------------------------------------
/**
* The meta-bean for {@code ManageableRegion}.
*/
public static class Meta extends DirectMetaBean {
/**
* The singleton instance of the meta-bean.
*/
static final Meta INSTANCE = new Meta();
/**
* The meta-property for the {@code uniqueId} property.
*/
private final MetaProperty<UniqueId> _uniqueId = DirectMetaProperty.ofReadWrite(
this, "uniqueId", ManageableRegion.class, UniqueId.class);
/**
* The meta-property for the {@code externalIdBundle} property.
*/
private final MetaProperty<ExternalIdBundle> _externalIdBundle = DirectMetaProperty.ofReadWrite(
this, "externalIdBundle", ManageableRegion.class, ExternalIdBundle.class);
/**
* The meta-property for the {@code classification} property.
*/
private final MetaProperty<RegionClassification> _classification = DirectMetaProperty.ofReadWrite(
this, "classification", ManageableRegion.class, RegionClassification.class);
/**
* The meta-property for the {@code parentRegionIds} property.
*/
@SuppressWarnings({"unchecked", "rawtypes" })
private final MetaProperty<Set<UniqueId>> _parentRegionIds = DirectMetaProperty.ofReadWrite(
this, "parentRegionIds", ManageableRegion.class, (Class) Set.class);
/**
* The meta-property for the {@code name} property.
*/
private final MetaProperty<String> _name = DirectMetaProperty.ofReadWrite(
this, "name", ManageableRegion.class, String.class);
/**
* The meta-property for the {@code fullName} property.
*/
private final MetaProperty<String> _fullName = DirectMetaProperty.ofReadWrite(
this, "fullName", ManageableRegion.class, String.class);
/**
* The meta-property for the {@code data} property.
*/
private final MetaProperty<FlexiBean> _data = DirectMetaProperty.ofReadWrite(
this, "data", ManageableRegion.class, FlexiBean.class);
/**
* The meta-properties.
*/
private final Map<String, MetaProperty<?>> _metaPropertyMap$ = new DirectMetaPropertyMap(
this, null,
"uniqueId",
"externalIdBundle",
"classification",
"parentRegionIds",
"name",
"fullName",
"data");
/**
* Restricted constructor.
*/
protected Meta() {
}
@Override
protected MetaProperty<?> metaPropertyGet(String propertyName) {
switch (propertyName.hashCode()) {
case -294460212: // uniqueId
return _uniqueId;
case -736922008: // externalIdBundle
return _externalIdBundle;
case 382350310: // classification
return _classification;
case 1273190810: // parentRegionIds
return _parentRegionIds;
case 3373707: // name
return _name;
case 1330852282: // fullName
return _fullName;
case 3076010: // data
return _data;
}
return super.metaPropertyGet(propertyName);
}
@Override
public BeanBuilder<? extends ManageableRegion> builder() {
return new DirectBeanBuilder<ManageableRegion>(new ManageableRegion());
}
@Override
public Class<? extends ManageableRegion> beanType() {
return ManageableRegion.class;
}
@Override
public Map<String, MetaProperty<?>> metaPropertyMap() {
return _metaPropertyMap$;
}
//-----------------------------------------------------------------------
/**
* The meta-property for the {@code uniqueId} property.
* @return the meta-property, not null
*/
public final MetaProperty<UniqueId> uniqueId() {
return _uniqueId;
}
/**
* The meta-property for the {@code externalIdBundle} property.
* @return the meta-property, not null
*/
public final MetaProperty<ExternalIdBundle> externalIdBundle() {
return _externalIdBundle;
}
/**
* The meta-property for the {@code classification} property.
* @return the meta-property, not null
*/
public final MetaProperty<RegionClassification> classification() {
return _classification;
}
/**
* The meta-property for the {@code parentRegionIds} property.
* @return the meta-property, not null
*/
public final MetaProperty<Set<UniqueId>> parentRegionIds() {
return _parentRegionIds;
}
/**
* The meta-property for the {@code name} property.
* @return the meta-property, not null
*/
public final MetaProperty<String> name() {
return _name;
}
/**
* The meta-property for the {@code fullName} property.
* @return the meta-property, not null
*/
public final MetaProperty<String> fullName() {
return _fullName;
}
/**
* The meta-property for the {@code data} property.
* @return the meta-property, not null
*/
public final MetaProperty<FlexiBean> data() {
return _data;
}
//-----------------------------------------------------------------------
@Override
protected Object propertyGet(Bean bean, String propertyName, boolean quiet) {
switch (propertyName.hashCode()) {
case -294460212: // uniqueId
return ((ManageableRegion) bean).getUniqueId();
case -736922008: // externalIdBundle
return ((ManageableRegion) bean).getExternalIdBundle();
case 382350310: // classification
return ((ManageableRegion) bean).getClassification();
case 1273190810: // parentRegionIds
return ((ManageableRegion) bean).getParentRegionIds();
case 3373707: // name
return ((ManageableRegion) bean).getName();
case 1330852282: // fullName
return ((ManageableRegion) bean).getFullName();
case 3076010: // data
return ((ManageableRegion) bean).getData();
}
return super.propertyGet(bean, propertyName, quiet);
}
@SuppressWarnings("unchecked")
@Override
protected void propertySet(Bean bean, String propertyName, Object newValue, boolean quiet) {
switch (propertyName.hashCode()) {
case -294460212: // uniqueId
((ManageableRegion) bean).setUniqueId((UniqueId) newValue);
return;
case -736922008: // externalIdBundle
((ManageableRegion) bean).setExternalIdBundle((ExternalIdBundle) newValue);
return;
case 382350310: // classification
((ManageableRegion) bean).setClassification((RegionClassification) newValue);
return;
case 1273190810: // parentRegionIds
((ManageableRegion) bean).setParentRegionIds((Set<UniqueId>) newValue);
return;
case 3373707: // name
((ManageableRegion) bean).setName((String) newValue);
return;
case 1330852282: // fullName
((ManageableRegion) bean).setFullName((String) newValue);
return;
case 3076010: // data
((ManageableRegion) bean).setData((FlexiBean) newValue);
return;
}
super.propertySet(bean, propertyName, newValue, quiet);
}
@Override
protected void validate(Bean bean) {
JodaBeanUtils.notNull(((ManageableRegion) bean)._data, "data");
}
}
///CLOVER:ON
//-------------------------- AUTOGENERATED END --------------------------
}