/*
    * MoneyWise: Finance Application
    * Copyright 2012-2026. Tony Washer
    *
    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
    * use this file except in compliance with the License.  You may obtain a copy
    * of the License at
    *
    *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
   * License for the specific language governing permissions and limitations under
   * the License.
   */
  package io.github.tonywasher.joceanus.moneywise.data.basic;
  
  import io.github.tonywasher.joceanus.oceanus.base.OceanusException;
  import io.github.tonywasher.joceanus.oceanus.format.OceanusDataFormatter;
  import io.github.tonywasher.joceanus.metis.data.MetisDataDifference;
  import io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataFieldId;
  import io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataNamedItem;
  import io.github.tonywasher.joceanus.metis.data.MetisDataResource;
  import io.github.tonywasher.joceanus.metis.field.MetisFieldSet;
  import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseDataValidator.MoneyWiseDataValidatorDefaults;
  import io.github.tonywasher.joceanus.moneywise.exc.MoneyWiseDataException;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusDataInstanceMap;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusDataItem;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusDataResource;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusDataValues;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusEncryptedDataItem;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusEncryptedFieldSet;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusEncryptedPair;
  import io.github.tonywasher.joceanus.prometheus.views.PrometheusEditSet;
  
  import java.util.Iterator;
  
  /**
   * Region for a Unit Trust.
   */
  public class MoneyWiseRegion
          extends PrometheusEncryptedDataItem
          implements MetisDataNamedItem {
      /**
       * Object name.
       */
      public static final String OBJECT_NAME = MoneyWiseBasicDataType.REGION.getItemName();
  
      /**
       * List name.
       */
      public static final String LIST_NAME = MoneyWiseBasicDataType.REGION.getListName();
  
      /**
       * Local Report fields.
       */
      private static final PrometheusEncryptedFieldSet<MoneyWiseRegion> FIELD_DEFS = PrometheusEncryptedFieldSet.newEncryptedFieldSet(MoneyWiseRegion.class);
  
      /*
       * FieldIds.
       */
      static {
          FIELD_DEFS.declareEncryptedStringField(PrometheusDataResource.DATAITEM_FIELD_NAME, NAMELEN);
          FIELD_DEFS.declareEncryptedStringField(PrometheusDataResource.DATAITEM_FIELD_DESC, DESCLEN);
      }
  
      /**
       * Copy Constructor.
       *
       * @param pList   the list
       * @param pRegion The region to copy
       */
      protected MoneyWiseRegion(final MoneyWiseRegionList pList,
                                final MoneyWiseRegion pRegion) {
          /* Set standard values */
          super(pList, pRegion);
      }
  
      /**
       * Values constructor.
       *
       * @param pList   the List to add to
       * @param pValues the values constructor
       * @throws OceanusException on error
       */
      private MoneyWiseRegion(final MoneyWiseRegionList pList,
                              final PrometheusDataValues pValues) throws OceanusException {
          /* Initialise the item */
          super(pList, pValues);
  
          /* Protect against exceptions */
          try {
              /* Store the Name */
              Object myValue = pValues.getValue(PrometheusDataResource.DATAITEM_FIELD_NAME);
              if (myValue instanceof String s) {
                  setValueName(s);
              } else if (myValue instanceof byte[] ba) {
                  setValueName(ba);
             }
 
             /* Store the Description */
             myValue = pValues.getValue(PrometheusDataResource.DATAITEM_FIELD_DESC);
             if (myValue instanceof String s) {
                 setValueDesc(s);
             } else if (myValue instanceof byte[] ba) {
                 setValueDesc(ba);
             }
 
             /* Catch Exceptions */
         } catch (OceanusException e) {
             /* Pass on exception */
             throw new MoneyWiseDataException(this, ERROR_CREATEITEM, e);
         }
     }
 
     /**
      * Edit Constructor.
      *
      * @param pList the list
      */
     public MoneyWiseRegion(final MoneyWiseRegionList pList) {
         super(pList, 0);
         setNextDataKeySet();
     }
 
     @Override
     public MetisFieldSetDef getDataFieldSet() {
         return FIELD_DEFS;
     }
 
     @Override
     public String formatObject(final OceanusDataFormatter pFormatter) {
         return toString();
     }
 
     @Override
     public String toString() {
         return getName();
     }
 
     @Override
     public boolean includeXmlField(final MetisDataFieldId pField) {
         /* Determine whether fields should be included */
         if (PrometheusDataResource.DATAITEM_FIELD_NAME.equals(pField)) {
             return true;
         }
         if (PrometheusDataResource.DATAITEM_FIELD_DESC.equals(pField)) {
             return getDesc() != null;
         }
 
         /* Pass call on */
         return super.includeXmlField(pField);
     }
 
     @Override
     public String getName() {
         return getValues().getValue(PrometheusDataResource.DATAITEM_FIELD_NAME, String.class);
     }
 
     /**
      * Obtain Encrypted name.
      *
      * @return the bytes
      */
     public byte[] getNameBytes() {
         return getValues().getEncryptedBytes(PrometheusDataResource.DATAITEM_FIELD_NAME);
     }
 
     /**
      * Obtain Encrypted Name Field.
      *
      * @return the Field
      */
     private PrometheusEncryptedPair getNameField() {
         return getValues().getEncryptedPair(PrometheusDataResource.DATAITEM_FIELD_NAME);
     }
 
     /**
      * Obtain Description.
      *
      * @return the description
      */
     public String getDesc() {
         return getValues().getValue(PrometheusDataResource.DATAITEM_FIELD_DESC, String.class);
     }
 
     /**
      * Obtain Encrypted description.
      *
      * @return the bytes
      */
     public byte[] getDescBytes() {
         return getValues().getEncryptedBytes(PrometheusDataResource.DATAITEM_FIELD_DESC);
     }
 
     /**
      * Obtain Encrypted Description Field.
      *
      * @return the Field
      */
     private PrometheusEncryptedPair getDescField() {
         return getValues().getEncryptedPair(PrometheusDataResource.DATAITEM_FIELD_DESC);
     }
 
     /**
      * Set name value.
      *
      * @param pValue the value
      * @throws OceanusException on error
      */
     private void setValueName(final String pValue) throws OceanusException {
         setEncryptedValue(PrometheusDataResource.DATAITEM_FIELD_NAME, pValue);
     }
 
     /**
      * Set name value.
      *
      * @param pBytes the value
      * @throws OceanusException on error
      */
     private void setValueName(final byte[] pBytes) throws OceanusException {
         setEncryptedValue(PrometheusDataResource.DATAITEM_FIELD_NAME, pBytes, String.class);
     }
 
     /**
      * Set name value.
      *
      * @param pValue the value
      */
     private void setValueName(final PrometheusEncryptedPair pValue) {
         getValues().setUncheckedValue(PrometheusDataResource.DATAITEM_FIELD_NAME, pValue);
     }
 
     /**
      * Set description value.
      *
      * @param pValue the value
      * @throws OceanusException on error
      */
     private void setValueDesc(final String pValue) throws OceanusException {
         setEncryptedValue(PrometheusDataResource.DATAITEM_FIELD_DESC, pValue);
     }
 
     /**
      * Set description value.
      *
      * @param pBytes the value
      * @throws OceanusException on error
      */
     private void setValueDesc(final byte[] pBytes) throws OceanusException {
         setEncryptedValue(PrometheusDataResource.DATAITEM_FIELD_DESC, pBytes, String.class);
     }
 
     /**
      * Set description value.
      *
      * @param pValue the value
      */
     private void setValueDesc(final PrometheusEncryptedPair pValue) {
         getValues().setUncheckedValue(PrometheusDataResource.DATAITEM_FIELD_DESC, pValue);
     }
 
     @Override
     public MoneyWiseDataSet getDataSet() {
         return (MoneyWiseDataSet) super.getDataSet();
     }
 
     @Override
     public MoneyWiseRegion getBase() {
         return (MoneyWiseRegion) super.getBase();
     }
 
     @Override
     public MoneyWiseRegionList getList() {
         return (MoneyWiseRegionList) super.getList();
     }
 
     /**
      * Set defaults.
      *
      * @throws OceanusException on error
      */
     public void setDefaults() throws OceanusException {
         getList().getValidator().setDefaults(this);
     }
 
     @Override
     public int compareValues(final PrometheusDataItem pThat) {
         /* Check the names */
         final MoneyWiseRegion myThat = (MoneyWiseRegion) pThat;
         return MetisDataDifference.compareObject(getName(), myThat.getName());
     }
 
     /**
      * Set a new tag name.
      *
      * @param pName the new name
      * @throws OceanusException on error
      */
     public void setName(final String pName) throws OceanusException {
         setValueName(pName);
     }
 
     /**
      * Set a new description.
      *
      * @param pDesc the description
      * @throws OceanusException on error
      */
     public void setDescription(final String pDesc) throws OceanusException {
         setValueDesc(pDesc);
     }
 
     /**
      * Update base tag from an edited tag.
      *
      * @param pTag the edited tag
      * @return whether changes have been made
      */
     @Override
     public boolean applyChanges(final PrometheusDataItem pTag) {
         /* Can only update from a region */
         if (!(pTag instanceof MoneyWiseRegion)) {
             return false;
         }
         final MoneyWiseRegion myRegion = (MoneyWiseRegion) pTag;
 
         /* Store the current detail into history */
         pushHistory();
 
         /* Update the Name if required */
         if (!MetisDataDifference.isEqual(getName(), myRegion.getName())) {
             setValueName(myRegion.getNameField());
         }
 
         /* Update the description if required */
         if (!MetisDataDifference.isEqual(getDesc(), myRegion.getDesc())) {
             setValueDesc(myRegion.getDescField());
         }
 
         /* Check for changes */
         return checkForHistory();
     }
 
     @Override
     public void adjustMapForItem() {
         final MoneyWiseRegionList myList = getList();
         final MoneyWiseRegionDataMap myMap = myList.getDataMap();
         myMap.adjustForItem(this);
     }
 
     /**
      * The Region List class.
      */
     public static class MoneyWiseRegionList
             extends PrometheusEncryptedList<MoneyWiseRegion> {
         /**
          * Report fields.
          */
         private static final MetisFieldSet<MoneyWiseRegionList> FIELD_DEFS = MetisFieldSet.newFieldSet(MoneyWiseRegionList.class);
 
         /**
          * Construct an empty CORE Tag list.
          *
          * @param pData the DataSet for the list
          */
         protected MoneyWiseRegionList(final MoneyWiseDataSet pData) {
             super(MoneyWiseRegion.class, pData, MoneyWiseBasicDataType.REGION, PrometheusListStyle.CORE);
         }
 
         /**
          * Constructor for a cloned List.
          *
          * @param pSource the source List
          */
         protected MoneyWiseRegionList(final MoneyWiseRegionList pSource) {
             super(pSource);
         }
 
         @Override
         public MetisFieldSet<MoneyWiseRegionList> getDataFieldSet() {
             return FIELD_DEFS;
         }
 
         @Override
         public String listName() {
             return LIST_NAME;
         }
 
         @Override
         public MetisFieldSetDef getItemFields() {
             return MoneyWiseRegion.FIELD_DEFS;
         }
 
         @Override
         public MoneyWiseDataSet getDataSet() {
             return (MoneyWiseDataSet) super.getDataSet();
         }
 
         @Override
         public MoneyWiseRegionDataMap getDataMap() {
             return (MoneyWiseRegionDataMap) super.getDataMap();
         }
 
         @Override
         @SuppressWarnings("unchecked")
         public MoneyWiseDataValidatorDefaults<MoneyWiseRegion> getValidator() {
             return (MoneyWiseDataValidatorDefaults<MoneyWiseRegion>) super.getValidator();
         }
 
         @Override
         protected MoneyWiseRegionList getEmptyList(final PrometheusListStyle pStyle) {
             final MoneyWiseRegionList myList = new MoneyWiseRegionList(this);
             myList.setStyle(pStyle);
             return myList;
         }
 
         /**
          * Derive Edit list.
          *
          * @param pEditSet the editSet
          * @return the edit list
          */
         public MoneyWiseRegionList deriveEditList(final PrometheusEditSet pEditSet) {
             /* Build an empty List */
             final MoneyWiseRegionList myList = getEmptyList(PrometheusListStyle.EDIT);
             myList.ensureMap();
             pEditSet.setEditEntryList(MoneyWiseBasicDataType.REGION, myList);
             myList.getValidator().setEditSet(pEditSet);
 
             /* Loop through the regions */
             final Iterator<MoneyWiseRegion> myIterator = iterator();
             while (myIterator.hasNext()) {
                 final MoneyWiseRegion myCurr = myIterator.next();
 
                 /* Ignore deleted regions */
                 if (myCurr.isDeleted()) {
                     continue;
                 }
 
                 /* Build the new linked region and add it to the list */
                 final MoneyWiseRegion myRegion = new MoneyWiseRegion(myList, myCurr);
                 myList.add(myRegion);
 
                 /* Adjust the map */
                 myRegion.adjustMapForItem();
             }
 
             /* Return the list */
             return myList;
         }
 
         /**
          * Add a new item to the core list.
          *
          * @param pRegion item
          * @return the newly added item
          */
         @Override
         public MoneyWiseRegion addCopyItem(final PrometheusDataItem pRegion) {
             /* Can only clone a Region */
             if (!(pRegion instanceof MoneyWiseRegion)) {
                 throw new UnsupportedOperationException();
             }
 
             final MoneyWiseRegion myRegion = new MoneyWiseRegion(this, (MoneyWiseRegion) pRegion);
             add(myRegion);
             return myRegion;
         }
 
         /**
          * Add a new item to the edit list.
          *
          * @return the new item
          */
         @Override
         public MoneyWiseRegion addNewItem() {
             final MoneyWiseRegion myRegion = new MoneyWiseRegion(this);
             add(myRegion);
             return myRegion;
         }
 
         @Override
         public MoneyWiseRegion findItemByName(final String pName) {
             /* look up the name in the map */
             return getDataMap().findItemByName(pName);
         }
 
         @Override
         public MoneyWiseRegion addValuesItem(final PrometheusDataValues pValues) throws OceanusException {
             /* Create the region */
             final MoneyWiseRegion myRegion = new MoneyWiseRegion(this, pValues);
 
             /* Check that this regionId has not been previously added */
             if (!isIdUnique(myRegion.getIndexedId())) {
                 myRegion.addError(ERROR_DUPLICATE, MetisDataResource.DATA_ID);
                 throw new MoneyWiseDataException(myRegion, ERROR_VALIDATION);
             }
 
             /* Add to the list */
             add(myRegion);
 
             /* Return it */
             return myRegion;
         }
 
         @Override
         protected MoneyWiseRegionDataMap allocateDataMap() {
             return new MoneyWiseRegionDataMap();
         }
     }
 
     /**
      * The dataMap class.
      */
     public static class MoneyWiseRegionDataMap
             extends PrometheusDataInstanceMap<MoneyWiseRegion, String> {
         @Override
         public void adjustForItem(final PrometheusDataItem pItem) {
             /* Access item */
             final MoneyWiseRegion myItem = (MoneyWiseRegion) pItem;
 
             /* Adjust name count */
             adjustForItem(myItem, myItem.getName());
         }
 
         /**
          * find item by name.
          *
          * @param pName the name to look up
          * @return the matching item
          */
         public MoneyWiseRegion findItemByName(final String pName) {
             return findItemByKey(pName);
         }
 
         /**
          * Check validity of name.
          *
          * @param pName the name to look up
          * @return true/false
          */
         public boolean validNameCount(final String pName) {
             return validKeyCount(pName);
         }
 
         /**
          * Check availability of name.
          *
          * @param pName the key to look up
          * @return true/false
          */
         public boolean availableName(final String pName) {
             return availableKey(pName);
         }
     }
 }