/*
    * Prometheus: Application Framework
    * 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.prometheus.data;
  
  import io.github.tonywasher.joceanus.gordianknot.api.factory.GordianFactory.GordianFactoryLock;
  import io.github.tonywasher.joceanus.gordianknot.api.keyset.GordianKeySetSpec;
  import io.github.tonywasher.joceanus.metis.data.MetisDataFieldValue;
  import io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataFieldId;
  import io.github.tonywasher.joceanus.metis.field.MetisFieldItem;
  import io.github.tonywasher.joceanus.metis.field.MetisFieldSet;
  import io.github.tonywasher.joceanus.metis.field.MetisFieldVersionedItem;
  import io.github.tonywasher.joceanus.metis.list.MetisListKey;
  import io.github.tonywasher.joceanus.metis.toolkit.MetisToolkit;
  import io.github.tonywasher.joceanus.oceanus.base.OceanusException;
  import io.github.tonywasher.joceanus.oceanus.format.OceanusDataFormatter;
  import io.github.tonywasher.joceanus.oceanus.profile.OceanusProfile;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusControlData.PrometheusControlDataList;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusControlKey.PrometheusControlKeyList;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusControlKeySet.PrometheusControlKeySetList;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusDataKeySet.PrometheusDataKeySetList;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusDataList.PrometheusDataListSet;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusDataList.PrometheusListStyle;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusDataValidator.PrometheusDataValidatorFactory;
  import io.github.tonywasher.joceanus.prometheus.data.PrometheusEncryptedDataItem.PrometheusEncryptedList;
  import io.github.tonywasher.joceanus.prometheus.preference.PrometheusPreferenceManager;
  import io.github.tonywasher.joceanus.prometheus.preference.PrometheusPreferenceSecurity.PrometheusSecurityPreferenceKey;
  import io.github.tonywasher.joceanus.prometheus.preference.PrometheusPreferenceSecurity.PrometheusSecurityPreferences;
  import io.github.tonywasher.joceanus.prometheus.security.PrometheusSecurityPasswordManager;
  import io.github.tonywasher.joceanus.prometheus.toolkit.PrometheusToolkit;
  import io.github.tonywasher.joceanus.tethys.api.thread.TethysUIThreadStatusReport;
  
  import java.util.Iterator;
  import java.util.LinkedHashMap;
  import java.util.Map;
  import java.util.Map.Entry;
  
  /**
   * DataSet definition and list. A DataSet is a set of DataLists backed by the three security lists.
   */
  public abstract class PrometheusDataSet
          implements MetisFieldItem, PrometheusDataListSet {
      /**
       * The Hash prime.
       */
      protected static final int HASH_PRIME = 19;
  
      /**
       * Report fields.
       */
      @SuppressWarnings("rawtypes")
      private static final MetisFieldSet<PrometheusDataSet> FIELD_DEFS = MetisFieldSet.newFieldSet(PrometheusDataSet.class);
  
      /*
       * Declare Fields.
       */
      static {
          FIELD_DEFS.declareLocalField(PrometheusDataResource.DATASET_VERSION, PrometheusDataSet::getVersion);
          FIELD_DEFS.declareLocalFieldsForEnum(PrometheusCryptographyDataType.class, PrometheusDataSet::getFieldListValue);
      }
  
      /**
       * SecurityInit Task.
       */
      private static final String TASK_SECINIT = PrometheusDataResource.TASK_SECURITY_INIT.getValue();
  
      /**
       * SecurityCheck Task.
       */
      private static final String TASK_SECCHECK = PrometheusDataResource.TASK_SECURITY_CHECK.getValue();
  
      /**
       * SecurityUpdate Task.
       */
      private static final String TASK_SECUPDATE = PrometheusDataResource.TASK_SECURITY_UPDATE.getValue();
  
      /**
       * SecurityReNew Task.
       */
      private static final String TASK_SECRENEW = PrometheusDataResource.TASK_SECURITY_RENEW.getValue();
  
      /**
       * DataReBase Task.
       */
      private static final String TASK_DATAREBASE = PrometheusDataResource.TASK_DATA_REBASE.getValue();
  
     /**
      * DataDiff Task.
      */
     private static final String TASK_DATADIFF = PrometheusDataResource.TASK_DATA_DIFF.getValue();
 
     /**
      * Password Manager.
      */
     private final PrometheusSecurityPasswordManager thePasswordMgr;
 
     /**
      * KeySetSpec.
      */
     private final GordianKeySetSpec theKeySetSpec;
 
     /**
      * Number of activeKeySets.
      */
     private final int theNumActiveKeySets;
 
     /**
      * Number of encrypted lists.
      */
     private int theNumEncrypted;
 
     /**
      * Version of dataSet.
      */
     private int theVersion;
 
     /**
      * The DataList Map.
      */
     private final Map<MetisListKey, PrometheusDataList<?>> theListMap;
 
     /**
      * General formatter.
      */
     private final OceanusDataFormatter theFormatter;
 
     /**
      * Validator factory.
      */
     private PrometheusDataValidatorFactory theValidatorFactory;
 
     /**
      * Constructor for new empty DataSet.
      *
      * @param pToolkit the toolkit set
      */
     protected PrometheusDataSet(final PrometheusToolkit pToolkit) {
         /* Store the password manager and Enum class */
         thePasswordMgr = pToolkit.getPasswordManager();
         theKeySetSpec = thePasswordMgr.getLockSpec().getKeySetSpec();
 
         /* Access the SecurityPreferences */
         final PrometheusPreferenceManager myPrefMgr = pToolkit.getPreferenceManager();
         final PrometheusSecurityPreferences mySecPreferences = myPrefMgr.getPreferenceSet(PrometheusSecurityPreferences.class);
         theNumActiveKeySets = mySecPreferences.getIntegerValue(PrometheusSecurityPreferenceKey.ACTIVEKEYSETS);
 
         /* Create the map of additional DataLists */
         theListMap = new LinkedHashMap<>();
 
         /* Loop through the list types */
         for (PrometheusCryptographyDataType myType : PrometheusCryptographyDataType.values()) {
             /* Create the empty list */
             addList(myType, newList(myType));
         }
 
         /* record formatter */
         final MetisToolkit myToolkit = pToolkit.getToolkit();
         theFormatter = myToolkit.getFormatter();
     }
 
     /**
      * Constructor for a cloned DataSet.
      *
      * @param pSource the source DataSet
      */
     protected PrometheusDataSet(final PrometheusDataSet pSource) {
 
         /* Access the #activeKeySets */
         theNumActiveKeySets = pSource.getNumActiveKeySets();
 
         /* Store the password manager */
         thePasswordMgr = pSource.getPasswordMgr();
 
         /* Store the keySetSpec */
         theKeySetSpec = pSource.getKeySetSpec();
 
         /* Create the map of additional DataLists */
         theListMap = new LinkedHashMap<>();
 
         /* Copy formatter */
         theFormatter = pSource.getDataFormatter();
 
         /* Copy validator factory */
         theValidatorFactory = pSource.theValidatorFactory;
     }
 
     @Override
     public String formatObject(final OceanusDataFormatter pFormatter) {
         return PrometheusDataSet.class.getSimpleName();
     }
 
     /**
      * Obtain the data formatter.
      *
      * @return the formatter
      */
     public OceanusDataFormatter getDataFormatter() {
         return theFormatter;
     }
 
     /**
      * Set the validator factory.
      *
      * @param pFactory the validator factory
      */
     public void setValidatorFactory(final PrometheusDataValidatorFactory pFactory) {
         theValidatorFactory = pFactory;
     }
 
     /**
      * Obtain a validator fot=r the itemType.
      *
      * @param pItemType the itemType
      * @return the validator.
      */
     PrometheusDataValidator getValidator(final MetisListKey pItemType) {
         if (theValidatorFactory == null) {
             throw new IllegalStateException("Validator factory not set");
         }
         return theValidatorFactory.newValidator(pItemType);
     }
 
     /**
      * Get Password Manager.
      *
      * @return the password manager
      */
     public PrometheusSecurityPasswordManager getPasswordMgr() {
         return thePasswordMgr;
     }
 
     /**
      * Get ControlKeys.
      *
      * @return the controlKeys
      */
     public PrometheusControlKeyList getControlKeys() {
         return getDataList(PrometheusCryptographyDataType.CONTROLKEY, PrometheusControlKeyList.class);
     }
 
     /**
      * Get ControlKeySets.
      *
      * @return the controlKeySets
      */
     public PrometheusControlKeySetList getControlKeySets() {
         return getDataList(PrometheusCryptographyDataType.CONTROLKEYSET, PrometheusControlKeySetList.class);
     }
 
     /**
      * Get DataKeySets.
      *
      * @return the dataKeySets
      */
     public PrometheusDataKeySetList getDataKeySets() {
         return getDataList(PrometheusCryptographyDataType.DATAKEYSET, PrometheusDataKeySetList.class);
     }
 
     /**
      * Get ControlData.
      *
      * @return the controlData
      */
     public PrometheusControlDataList getControlData() {
         return getDataList(PrometheusCryptographyDataType.CONTROLDATA, PrometheusControlDataList.class);
     }
 
     /**
      * Get Version.
      *
      * @return the version
      */
     public int getVersion() {
         return theVersion;
     }
 
     /**
      * Get Number of activeKeySets.
      *
      * @return the # active KeySets
      */
     public int getNumActiveKeySets() {
         return theNumActiveKeySets;
     }
 
     /**
      * Get KeySetSpec.
      *
      * @return the keySetSpec
      */
     public GordianKeySetSpec getKeySetSpec() {
         return theKeySetSpec;
     }
 
     /**
      * Get List Map.
      *
      * @return the list map
      */
     protected Map<MetisListKey, PrometheusDataList<?>> getListMap() {
         return theListMap;
     }
 
     @Override
     public boolean hasDataType(final MetisListKey pDataType) {
         return theListMap.containsKey(pDataType);
     }
 
     /**
      * Construct a Clone for a DataSet.
      *
      * @return the extract
      * @throws OceanusException on error
      */
     public abstract PrometheusDataSet deriveCloneSet() throws OceanusException;
 
     /**
      * Create new list of required type.
      *
      * @param pListType the list type
      * @return the new list
      */
     private PrometheusDataList<?> newList(final PrometheusCryptographyDataType pListType) {
         /* Switch on list Type */
         switch (pListType) {
             case CONTROLDATA:
                 return new PrometheusControlDataList(this);
             case CONTROLKEY:
                 return new PrometheusControlKeyList(this);
             case CONTROLKEYSET:
                 return new PrometheusControlKeySetList(this);
             case DATAKEYSET:
                 return new PrometheusDataKeySetList(this);
             default:
                 throw new IllegalArgumentException(pListType.toString());
         }
     }
 
     /**
      * Build an empty clone dataSet.
      *
      * @param pSource the source DataSet
      * @throws OceanusException on error
      */
     protected void buildEmptyCloneSet(final PrometheusDataSet pSource) throws OceanusException {
         /* Loop through the source lists */
         final Iterator<Entry<MetisListKey, PrometheusDataList<?>>> myIterator = pSource.entryIterator();
         while (myIterator.hasNext()) {
             final Entry<MetisListKey, PrometheusDataList<?>> myEntry = myIterator.next();
 
             /* Access components */
             final MetisListKey myType = myEntry.getKey();
             final PrometheusDataList<?> myList = myEntry.getValue();
 
             /* Create the empty cloned list */
             addList(myType, myList.getEmptyList(PrometheusListStyle.CLONE));
         }
     }
 
     /**
      * Construct a Clone for a DataSet.
      *
      * @param pSource the source DataSet
      * @throws OceanusException on error
      */
     protected void deriveCloneSet(final PrometheusDataSet pSource) throws OceanusException {
         /* Obtain listMaps */
         final Map<MetisListKey, PrometheusDataList<?>> myOldMap = pSource.getListMap();
 
         /* Loop through the new lists */
         final Iterator<Entry<MetisListKey, PrometheusDataList<?>>> myIterator = entryIterator();
         while (myIterator.hasNext()) {
             final Entry<MetisListKey, PrometheusDataList<?>> myEntry = myIterator.next();
 
             /* Access components */
             final MetisListKey myType = myEntry.getKey();
             final PrometheusDataList<?> myNew = myEntry.getValue();
             final PrometheusDataList<?> myOld = myOldMap.get(myType);
 
             /* Clone the list */
             myNew.cloneList(this, myOld);
         }
     }
 
     /**
      * Construct an update extract for a FinanceData Set.
      *
      * @return the extract
      * @throws OceanusException on error
      */
     public abstract PrometheusDataSet deriveUpdateSet() throws OceanusException;
 
     /**
      * Construct an update extract for a DataSet.
      *
      * @param pSource the source of the extract
      * @throws OceanusException on error
      */
     protected void deriveUpdateSet(final PrometheusDataSet pSource) throws OceanusException {
         /* Loop through the source lists */
         final Iterator<Entry<MetisListKey, PrometheusDataList<?>>> myIterator = pSource.entryIterator();
         while (myIterator.hasNext()) {
             final Entry<MetisListKey, PrometheusDataList<?>> myEntry = myIterator.next();
 
             /* Access components */
             final MetisListKey myType = myEntry.getKey();
             final PrometheusDataList<?> myList = myEntry.getValue();
 
             /* Create the update list */
             addList(myType, myList.deriveList(PrometheusListStyle.UPDATE));
         }
 
         /* If we have updates */
         if (!isEmpty()) {
             /* Update the version */
             setVersion(1);
         }
     }
 
     /**
      * Construct a difference extract between two DataSets. The difference extract will only contain
      * items that differ between the two DataSets. Items that are in the new list, but not in the
      * old list will be viewed as inserted. Items that are in the old list but not in the new list
      * will be viewed as deleted. Items that are in both list but differ will be viewed as changed
      *
      * @param pReport the report
      * @param pOld    The old list to extract from
      * @return the difference set
      * @throws OceanusException on error
      */
     public abstract PrometheusDataSet getDifferenceSet(TethysUIThreadStatusReport pReport,
                                                        PrometheusDataSet pOld) throws OceanusException;
 
     /**
      * Construct a difference extract between two DataSets. The difference extract will only contain
      * items that differ between the two DataSets. Items that are in the new list, but not in the
      * old list will be viewed as inserted. Items that are in the old list but not in the new list
      * will be viewed as deleted. Items that are in both list but differ will be viewed as changed
      *
      * @param pReport the report
      * @param pNew    The new list to compare
      * @param pOld    The old list to compare
      * @throws OceanusException on error
      */
     protected void deriveDifferences(final TethysUIThreadStatusReport pReport,
                                      final PrometheusDataSet pNew,
                                      final PrometheusDataSet pOld) throws OceanusException {
         /* Access current profile */
         final OceanusProfile myTask = pReport.getActiveTask();
         final OceanusProfile myStage = myTask.startTask(TASK_DATADIFF);
 
         /* Obtain listMaps */
         final Map<MetisListKey, PrometheusDataList<?>> myOldMap = pOld.getListMap();
 
         /* Loop through the new lists */
         final Iterator<Entry<MetisListKey, PrometheusDataList<?>>> myIterator = pNew.entryIterator();
         while (myIterator.hasNext()) {
             final Entry<MetisListKey, PrometheusDataList<?>> myEntry = myIterator.next();
 
             /* Access components */
             final MetisListKey myType = myEntry.getKey();
             final PrometheusDataList<?> myNew = myEntry.getValue();
             final PrometheusDataList<?> myOld = myOldMap.get(myType);
 
             /* Derive Differences */
             myStage.startTask(myNew.listName());
             addList(myType, myNew.deriveDifferences(this, myOld));
         }
 
         /* Complete task */
         myStage.end();
     }
 
     /**
      * ReBase this data set against an earlier version.
      *
      * @param pReport the report
      * @param pOld    The old data to reBase against
      * @throws OceanusException on error
      */
     public void reBase(final TethysUIThreadStatusReport pReport,
                        final PrometheusDataSet pOld) throws OceanusException {
         /* Access current profile */
         final OceanusProfile myTask = pReport.getActiveTask();
         final OceanusProfile myStage = myTask.startTask(TASK_DATAREBASE);
 
         /* Obtain old listMap */
         final Map<MetisListKey, PrometheusDataList<?>> myMap = pOld.getListMap();
 
         /* Loop through the lists */
         boolean bUpdates = false;
         final Iterator<Entry<MetisListKey, PrometheusDataList<?>>> myIterator = entryIterator();
         while (myIterator.hasNext()) {
             final Entry<MetisListKey, PrometheusDataList<?>> myEntry = myIterator.next();
 
             /* Access components */
             final MetisListKey myType = myEntry.getKey();
             final PrometheusDataList<?> myList = myEntry.getValue();
 
             /* ReBase on Old dataList */
             myStage.startTask(myList.listName());
             bUpdates |= myList.reBase(myMap.get(myType));
         }
 
         /* If we have updates */
         if (bUpdates) {
             /* Update the version */
             setVersion(getVersion() + 1);
         }
 
         /* Complete task */
         myStage.end();
     }
 
     /**
      * Add DataList to list of lists.
      *
      * @param pListType the list type
      * @param pList     the list to add
      */
     protected void addList(final MetisListKey pListType,
                            final PrometheusDataList<?> pList) {
         /* Add the DataList to the map */
         theListMap.put(pListType, pList);
 
         /* Note if the list is an encrypted list */
         if (pList instanceof PrometheusEncryptedList) {
             theNumEncrypted++;
         }
     }
 
     @Override
     public <L extends PrometheusDataList<?>> L getDataList(final MetisListKey pListType,
                                                            final Class<L> pListClass) {
         /* Access the list */
         final PrometheusDataList<?> myList = theListMap.get(pListType);
 
         /* Cast correctly */
         return myList == null
                 ? null
                 : pListClass.cast(myList);
     }
 
     /**
      * Obtain debug value for list.
      *
      * @param pListType the list type
      * @return true/false
      */
     protected Object getFieldListValue(final MetisListKey pListType) {
         /* Access the class */
         final PrometheusDataList<?> myList = theListMap.get(pListType);
 
         /* Cast correctly */
         return myList == null
                 || myList.isEmpty()
                 ? MetisDataFieldValue.SKIP
                 : myList;
     }
 
     /**
      * Obtain DataList for an list class.
      *
      * @param <L>        the List type
      * @param pListClass the class of the list
      * @return the list of items
      */
     public <L extends PrometheusDataList<?>> L getDataList(final Class<L> pListClass) {
         /* Loop through the lists */
         final Iterator<Entry<MetisListKey, PrometheusDataList<?>>> myIterator = entryIterator();
         while (myIterator.hasNext()) {
             final Entry<MetisListKey, PrometheusDataList<?>> myEntry = myIterator.next();
 
             /* Access components */
             final PrometheusDataList<?> myList = myEntry.getValue();
             if (pListClass.equals(myList.getClass())) {
                 return pListClass.cast(myList);
             }
         }
 
         /* Not found */
         return null;
     }
 
     /**
      * Set Version.
      *
      * @param pVersion the version
      */
     public void setVersion(final int pVersion) {
         /* Record the version */
         theVersion = pVersion;
 
         /* Loop through the List values */
         final Iterator<PrometheusDataList<?>> myIterator = iterator();
         while (myIterator.hasNext()) {
             final PrometheusDataList<?> myList = myIterator.next();
 
             /* Set the Version */
             myList.setVersion(pVersion);
         }
     }
 
     /**
      * Rewind items to the required version.
      *
      * @param pVersion the version to rewind to
      */
     public void rewindToVersion(final int pVersion) {
         /* Record the version */
         theVersion = pVersion;
 
         /* Loop through the List values */
         final Iterator<PrometheusDataList<?>> myIterator = iterator();
         while (myIterator.hasNext()) {
             final PrometheusDataList<?> myList = myIterator.next();
 
             /* Rewind the list */
             myList.rewindToVersion(pVersion);
         }
     }
 
     @Override
     public boolean equals(final Object pThat) {
         /* Handle the trivial cases */
         if (this == pThat) {
             return true;
         }
         if (pThat == null) {
             return false;
         }
 
         /* Make sure that the object is a DataSet */
         if (pThat.getClass() != this.getClass()) {
             return false;
         }
 
         /* Access the object as a DataSet */
         final PrometheusDataSet myThat = (PrometheusDataSet) pThat;
 
         /* Check version and generation */
         if (myThat.getVersion() != theVersion) {
             return false;
         }
 
         /* Compare the maps */
         return theListMap.equals(myThat.getListMap());
     }
 
     @Override
     public int hashCode() {
         /* Build initial hashCode */
         int myHashCode = 0;
 
         /* Loop through the List values */
         final Iterator<PrometheusDataList<?>> myIterator = iterator();
         while (myIterator.hasNext()) {
             final PrometheusDataList<?> myList = myIterator.next();
 
             /* Access equivalent list */
             myHashCode *= HASH_PRIME;
             myHashCode += myList.hashCode();
         }
 
         /* Return the hashCode */
         return myHashCode;
     }
 
     /**
      * Determine whether a DataSet has entries.
      *
      * @return <code>true</code> if the DataSet has entries
      */
     public boolean isEmpty() {
         /* Loop through the List values */
         final Iterator<PrometheusDataList<?>> myIterator = iterator();
         while (myIterator.hasNext()) {
             final PrometheusDataList<?> myList = myIterator.next();
 
             /* Determine whether the list is empty */
             if (!myList.isEmpty()) {
                 return false;
             }
         }
 
         /* Return the indication */
         return true;
     }
 
     /**
      * Determine whether the Data-set has updates.
      *
      * @return <code>true</code> if the Data-set has updates, <code>false</code> if not
      */
     public boolean hasUpdates() {
         /* Loop through the List values */
         final Iterator<PrometheusDataList<?>> myIterator = iterator();
         while (myIterator.hasNext()) {
             final PrometheusDataList<?> myList = myIterator.next();
 
             /* Determine whether the list has updates */
             if (myList.hasUpdates()) {
                 return true;
             }
         }
 
         /* We have no updates */
         return false;
     }
 
     /**
      * Get the control record.
      *
      * @return the control record
      */
     public PrometheusControlData getControl() {
         /* Set the control */
         return getControlData().getControl();
     }
 
     /**
      * Get the active control key.
      *
      * @return the control key
      */
     public PrometheusControlKey getControlKey() {
         /* Access the control element from the database */
         final PrometheusControlData myControl = getControl();
 
         /* Return the key */
         return myControl == null ? null : myControl.getControlKey();
     }
 
     /**
      * Initialise Security from database (if present).
      *
      * @param pReport the report
      * @param pBase   the database data
      * @throws OceanusException on error
      */
     public void initialiseSecurity(final TethysUIThreadStatusReport pReport,
                                    final PrometheusDataSet pBase) throws OceanusException {
         /* Access current profile */
         final OceanusProfile myTask = pReport.getActiveTask();
         final OceanusProfile myStage = myTask.startTask(TASK_SECINIT);
 
         /* Set the number of stages */
         pReport.initTask(TASK_SECINIT);
         pReport.setNumStages(theNumEncrypted);
 
         /* Initialise Security */
         getControlKeys().initialiseSecurity(pBase);
 
         /* Obtain base listMap */
         final Map<MetisListKey, PrometheusDataList<?>> myMap = pBase.getListMap();
 
         /* Loop through the List values */
         final Iterator<Entry<MetisListKey, PrometheusDataList<?>>> myIterator = entryIterator();
         while (myIterator.hasNext()) {
             final Entry<MetisListKey, PrometheusDataList<?>> myEntry = myIterator.next();
 
             /* Access the two lists */
             final PrometheusDataList<?> myList = myEntry.getValue();
             final PrometheusDataList<?> myBase = myMap.get(myEntry.getKey());
 
             /* If the list is an encrypted list */
             if (myList instanceof PrometheusEncryptedList) {
                 /* Adopt the security */
                 myStage.startTask(myList.listName());
                 final PrometheusEncryptedList<?> myEncrypted = (PrometheusEncryptedList<?>) myList;
                 myEncrypted.adoptSecurity(pReport, (PrometheusEncryptedList<?>) myBase);
             }
         }
 
         /* Complete the task */
         myStage.end();
     }
 
     /**
      * Renew Security.
      *
      * @param pReport the report
      * @throws OceanusException on error
      */
     public void renewSecurity(final TethysUIThreadStatusReport pReport) throws OceanusException {
         /* Access current profile */
         final OceanusProfile myTask = pReport.getActiveTask();
         final OceanusProfile myStage = myTask.startTask(TASK_SECRENEW);
 
         /* Access ControlData */
         final PrometheusControlData myControl = getControl();
 
         /* Clone the control key */
         final PrometheusControlKey myKey = getControlKeys().cloneItem(myControl.getControlKey());
 
         /* Declare the New Control Key */
         myControl.setControlKey(myKey);
 
         /* Update Security */
         updateSecurity(pReport);
 
         /* Complete task */
         myStage.end();
     }
 
     /**
      * Check Security for incomplete security operations.
      *
      * @param pReport the report
      * @throws OceanusException on error
      */
     public void checkSecurity(final TethysUIThreadStatusReport pReport) throws OceanusException {
         /* Access current profile */
         final OceanusProfile myTask = pReport.getActiveTask();
         final OceanusProfile myStage = myTask.startTask(TASK_SECCHECK);
 
         /* If there is more than one controlKey */
         if (getControlKeys().size() > 1) {
             /* Update to the selected controlKey */
             updateSecurity(pReport);
         }
 
         /* Complete task */
         myStage.end();
     }
 
     /**
      * Update Security.
      *
      * @param pReport the report
      * @throws OceanusException on error
      */
     public void updateSecurity(final TethysUIThreadStatusReport pReport) throws OceanusException {
         /* Access the control key */
         final PrometheusControlKey myControl = getControlKey();
 
         /* Set the number of stages */
         pReport.initTask(TASK_SECUPDATE);
         pReport.setNumStages(theNumEncrypted);
 
         /* Loop through the List values */
         final Iterator<PrometheusDataList<?>> myIterator = iterator();
         while (myIterator.hasNext()) {
             final PrometheusDataList<?> myList = myIterator.next();
 
             /* If the list is an encrypted list */
             if (myList instanceof PrometheusEncryptedList) {
                 /* Update the security */
                 final PrometheusEncryptedList<?> myEncrypted = (PrometheusEncryptedList<?>) myList;
                 myEncrypted.updateSecurity(pReport, myControl);
             }
         }
 
         /* Delete old ControlSets */
         getControlKeys().purgeOldControlKeys();
         setVersion(1);
     }
 
     /**
      * Get the Password Hash.
      *
      * @return the password hash
      * @throws OceanusException on error
      */
     public GordianFactoryLock getFactoryLock() throws OceanusException {
         /* Access the active control key */
         final PrometheusControlKey myKey = getControlKey();
 
         /* Set the control */
         return myKey == null
                 ? null
                 : myKey.getFactoryLock();
     }
 
     /**
      * Update data with a new password.
      *
      * @param pReport the report
      * @param pSource the source of the data
      * @throws OceanusException on error
      */
     public void updateFactoryLock(final TethysUIThreadStatusReport pReport,
                                   final String pSource) throws OceanusException {
         /* Update the control details */
         getControlKey().updateFactoryLock(pSource);
     }
 
     /**
      * Undo changes in a dataSet.
      */
     public void undoLastChange() {
         /* Ignore if we have no changes */
         if (theVersion == 0) {
             return;
         }
 
         /* Decrement version */
         theVersion--;
 
         /* Rewind to the version */
         rewindToVersion(theVersion);
     }
 
     /**
      * Reset changes in a dataSet.
      */
     public void resetChanges() {
         /* Ignore if we have no changes */
         if (theVersion == 0) {
             return;
         }
 
         /* Decrement version */
         theVersion = 0;
 
         /* Rewind to the version */
         rewindToVersion(theVersion);
     }
 
     /**
      * Obtain list iterator.
      *
      * @return the iterator
      */
     public Iterator<PrometheusDataList<?>> iterator() {
         return theListMap.values().iterator();
     }
 
     /**
      * Obtain list iterator.
      *
      * @return the iterator
      */
     public Iterator<Entry<MetisListKey, PrometheusDataList<?>>> entryIterator() {
         return theListMap.entrySet().iterator();
     }
 
     /**
      * Obtain listKey iterator.
      *
      * @return the iterator
      */
     public Iterator<MetisListKey> keyIterator() {
         return theListMap.keySet().iterator();
     }
 
     /**
      * Cryptography Data Enum Types.
      */
     public enum PrometheusCryptographyDataType
             implements MetisListKey, MetisDataFieldId {
         /**
          * ControlKey.
          */
         CONTROLKEY(1),
 
         /**
          * ControlKeySet.
          */
         CONTROLKEYSET(2),
 
         /**
          * DataKeySet.
          */
         DATAKEYSET(3),
 
         /**
          * ControlData.
          */
         CONTROLDATA(4);
 
         /**
          * Maximum keyId.
          */
         public static final Integer MAXKEYID = CONTROLDATA.getItemKey();
 
         /**
          * The list key.
          */
         private final Integer theKey;
 
         /**
          * The String name.
          */
         private String theName;
 
         /**
          * The list name.
          */
         private String theListName;
 
         /**
          * Constructor.
          *
          * @param pKey the key
          */
         PrometheusCryptographyDataType(final Integer pKey) {
             theKey = pKey;
         }
 
         @Override
         public String toString() {
             /* If we have not yet loaded the name */
             if (theName == null) {
                 /* Load the name */
                 theName = PrometheusDataResource.getKeyForCryptoItem(this).getValue();
             }
 
             /* return the name */
             return theName;
         }
 
         @Override
         public String getItemName() {
             return toString();
         }
 
         @Override
         public Class<? extends MetisFieldVersionedItem> getClazz() {
             switch (this) {
                 case CONTROLDATA:
                     return PrometheusControlData.class;
                 case CONTROLKEY:
                     return PrometheusControlKey.class;
                 case CONTROLKEYSET:
                     return PrometheusControlKeySet.class;
                 case DATAKEYSET:
                     return PrometheusDataKeySet.class;
                 default:
                     return null;
             }
         }
 
         @Override
         public String getListName() {
             /* If we have not yet loaded the name */
             if (theListName == null) {
                 /* Load the name */
                 theListName = PrometheusDataResource.getKeyForCryptoList(this).getValue();
             }
 
             /* return the list name */
             return theListName;
         }
 
         @Override
         public Integer getItemKey() {
             return theKey;
         }
 
         @Override
         public String getId() {
             return toString();
         }
     }
 }