ObservableStampCoordinateImpl.java

/* 
 * 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.
 *
 * Contributions from 2013-2017 where performed either by US government 
 * employees, or under US Veterans Health Administration contracts. 
 *
 * US Veterans Health Administration contributions by government employees
 * are work of the U.S. Government and are not subject to copyright
 * protection in the United States. Portions contributed by government 
 * employees are USGovWork (17USC §105). Not subject to copyright. 
 * 
 * Contribution by contractors to the US Veterans Health Administration
 * during this period are contractually contributed under the
 * Apache License, Version 2.0.
 *
 * See: https://www.usa.gov/government-works
 * 
 * Contributions prior to 2013:
 *
 * Copyright (C) International Health Terminology Standards Development Organisation.
 * Licensed under the Apache License, Version 2.0.
 *
 */



package sh.isaac.model.observable.coordinate;

//~--- JDK imports ------------------------------------------------------------

import java.util.EnumSet;

//~--- non-JDK imports --------------------------------------------------------

import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SetProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.beans.property.SimpleSetProperty;

import javafx.collections.FXCollections;
import javafx.collections.ObservableIntegerArray;

import sh.isaac.api.State;
import sh.isaac.api.collections.ConceptSequenceSet;
import sh.isaac.api.coordinate.StampCoordinate;
import sh.isaac.api.coordinate.StampPrecedence;
import sh.isaac.api.observable.coordinate.ObservableStampCoordinate;
import sh.isaac.api.observable.coordinate.ObservableStampPosition;
import sh.isaac.model.coordinate.StampCoordinateImpl;
import sh.isaac.model.observable.ObservableFields;

//~--- classes ----------------------------------------------------------------

/**
 * The Class ObservableStampCoordinateImpl.
 *
 * @author kec
 */
public class ObservableStampCoordinateImpl
        extends ObservableCoordinateImpl
         implements ObservableStampCoordinate {
   /** The stamp coordinate. */
   StampCoordinateImpl stampCoordinate;

   /** The stamp precedence property. */
   ObjectProperty<StampPrecedence> stampPrecedenceProperty;

   /** The stamp position property. */
   ObjectProperty<ObservableStampPosition> stampPositionProperty;

   /** The module sequences property. */
   ObjectProperty<ObservableIntegerArray> moduleSequencesProperty;

   /** The allowed states. */
   SetProperty<State> allowedStates;

   //~--- constructors --------------------------------------------------------

   /**
    * Instantiates a new observable stamp coordinate impl.
    *
    * @param stampCoordinate the stamp coordinate
    */
   public ObservableStampCoordinateImpl(StampCoordinate stampCoordinate) {
      if (stampCoordinate instanceof ObservableStampCoordinateImpl) {
         this.stampCoordinate = ((ObservableStampCoordinateImpl) stampCoordinate).stampCoordinate;
      } else {
         this.stampCoordinate = (StampCoordinateImpl) stampCoordinate;
      }
   }

   //~--- methods -------------------------------------------------------------

   /**
    * Allowed states property.
    *
    * @return the set property
    */
   @Override
   public SetProperty<State> allowedStatesProperty() {
      if (this.allowedStates == null) {
         this.allowedStates = new SimpleSetProperty<>(this,
               ObservableFields.ALLOWED_STATES_FOR_STAMP_COORDINATE.toExternalString(),
               FXCollections.observableSet(this.stampCoordinate.getAllowedStates()));
         this.stampCoordinate.setAllowedStatesProperty(this.allowedStates);
      }

      return this.allowedStates;
   }

   /**
    * Make analog.
    *
    * @param stampPositionTime the stamp position time
    * @return the observable stamp coordinate impl
    */
   @Override
   public ObservableStampCoordinateImpl makeAnalog(long stampPositionTime) {
      final StampCoordinate analog = this.stampCoordinate.makeAnalog(stampPositionTime);

      return new ObservableStampCoordinateImpl(analog);
   }

   /**
    * Make analog.
    *
    * @param state the state
    * @return the observable stamp coordinate
    */
   @Override
   public ObservableStampCoordinate makeAnalog(State... state) {
      final StampCoordinate analog = this.stampCoordinate.makeAnalog(state);

      return new ObservableStampCoordinateImpl(analog);
   }

   /**
    * Module sequences property.
    *
    * @return the object property
    */
   @Override
   public ObjectProperty<ObservableIntegerArray> moduleSequencesProperty() {
      if (this.moduleSequencesProperty == null) {
         this.moduleSequencesProperty = new SimpleObjectProperty<>(this,
               ObservableFields.MODULE_SEQUENCE_ARRAY_FOR_STAMP_COORDINATE.toExternalString(),
               FXCollections.observableIntegerArray(getModuleSequences().asArray()));
         addListenerReference(this.stampCoordinate.setModuleSequencesProperty(this.moduleSequencesProperty));
      }

      return this.moduleSequencesProperty;
   }

   /**
    * Stamp position property.
    *
    * @return the object property
    */
   @Override
   public ObjectProperty<ObservableStampPosition> stampPositionProperty() {
      if (this.stampPositionProperty == null) {
         this.stampPositionProperty = new SimpleObjectProperty<>(this,
               ObservableFields.STAMP_POSITION_FOR_STAMP_COORDINATE.toExternalString(),
               new ObservableStampPositionImpl(this.stampCoordinate.getStampPosition()));
         addListenerReference(this.stampCoordinate.setStampPositionProperty(this.stampPositionProperty));
      }

      return this.stampPositionProperty;
   }

   /**
    * Stamp precedence property.
    *
    * @return the object property
    */
   @Override
   public ObjectProperty<StampPrecedence> stampPrecedenceProperty() {
      if (this.stampPrecedenceProperty == null) {
         this.stampPrecedenceProperty = new SimpleObjectProperty<>(this,
               ObservableFields.STAMP_PRECEDENCE_FOR_STAMP_COORDINATE.toExternalString(),
               getStampPrecedence());
         addListenerReference(this.stampCoordinate.setStampPrecedenceProperty(this.stampPrecedenceProperty));
      }

      return this.stampPrecedenceProperty;
   }

   /**
    * To string.
    *
    * @return the string
    */
   @Override
   public String toString() {
      return "ObservableStampCoordinateImpl{" + this.stampCoordinate + '}';
   }

   //~--- get methods ---------------------------------------------------------

   /**
    * Gets the allowed states.
    *
    * @return the allowed states
    */
   @Override
   public EnumSet<State> getAllowedStates() {
      return this.stampCoordinate.getAllowedStates();
   }

   /**
    * Gets the module sequences.
    *
    * @return the module sequences
    */
   @Override
   public ConceptSequenceSet getModuleSequences() {
      if (this.moduleSequencesProperty != null) {
         return ConceptSequenceSet.of(this.moduleSequencesProperty.get()
               .toArray(new int[0]));
      }

      return this.stampCoordinate.getModuleSequences();
   }

   /**
    * Gets the stamp position.
    *
    * @return the stamp position
    */
   @Override
   public ObservableStampPosition getStampPosition() {
      return stampPositionProperty().get();
   }

   /**
    * Gets the stamp precedence.
    *
    * @return the stamp precedence
    */
   @Override
   public StampPrecedence getStampPrecedence() {
      if (this.stampPrecedenceProperty != null) {
         return this.stampPrecedenceProperty.get();
      }

      return this.stampCoordinate.getStampPrecedence();
   }
}