TypedNodeWithSequences.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.logic.node.internal;

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

import java.io.DataInputStream;
import java.io.DataOutput;
import java.io.IOException;

import java.util.Arrays;

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

import sh.isaac.api.DataTarget;
import sh.isaac.api.Get;
import sh.isaac.api.collections.ConceptSequenceSet;
import sh.isaac.api.logic.LogicNode;
import sh.isaac.model.logic.LogicalExpressionOchreImpl;
import sh.isaac.model.logic.node.AbstractLogicNode;
import sh.isaac.model.logic.node.ConnectorNode;
import sh.isaac.model.logic.node.external.TypedNodeWithUuids;

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

/**
 * Created by kec on 12/9/14.
 */
public abstract class TypedNodeWithSequences
        extends ConnectorNode {
   /** The type concept sequence. */
   int typeConceptSequence;

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

   /**
    * Instantiates a new typed node with sequences.
    *
    * @param externalForm the external form
    */
   public TypedNodeWithSequences(TypedNodeWithUuids externalForm) {
      super(externalForm);
      this.typeConceptSequence = Get.identifierService()
                                    .getConceptSequenceForUuids(externalForm.getTypeConceptUuid());
   }

   /**
    * Instantiates a new typed node with sequences.
    *
    * @param logicGraphVersion the logic graph version
    * @param dataInputStream the data input stream
    * @throws IOException Signals that an I/O exception has occurred.
    */
   public TypedNodeWithSequences(LogicalExpressionOchreImpl logicGraphVersion,
                                 DataInputStream dataInputStream)
            throws IOException {
      super(logicGraphVersion, dataInputStream);
      this.typeConceptSequence = dataInputStream.readInt();
   }

   /**
    * Instantiates a new typed node with sequences.
    *
    * @param logicGraphVersion the logic graph version
    * @param typeConceptId the type concept id
    * @param child the child
    */
   public TypedNodeWithSequences(LogicalExpressionOchreImpl logicGraphVersion,
                                 int typeConceptId,
                                 AbstractLogicNode child) {
      super(logicGraphVersion, child);
      this.typeConceptSequence = Get.identifierService()
                                    .getConceptSequence(typeConceptId);
   }

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

   /**
    * Adds the concepts referenced by node.
    *
    * @param conceptSequenceSet the concept sequence set
    */
   @Override
   public void addConceptsReferencedByNode(ConceptSequenceSet conceptSequenceSet) {
      super.addConceptsReferencedByNode(conceptSequenceSet);
      conceptSequenceSet.add(this.typeConceptSequence);
   }

   /**
    * Equals.
    *
    * @param obj the obj
    * @return true, if successful
    */
   @Override
   public boolean equals(Object obj) {
      if (obj == null) {
         return false;
      }

      if (getClass() != obj.getClass()) {
         return false;
      }

      final TypedNodeWithSequences other = (TypedNodeWithSequences) obj;

      if (this.typeConceptSequence != other.typeConceptSequence) {
         return false;
      }

      return super.equals(obj);
   }

   /**
    * Hash code.
    *
    * @return the int
    */
   @Override
   public int hashCode() {
      int hash = 3;

      hash = 97 * hash + this.typeConceptSequence;
      return hash;
   }

   /**
    * To string.
    *
    * @return the string
    */
   @Override
   public String toString() {
      return toString("");
   }

   /**
    * To string.
    *
    * @param nodeIdSuffix the node id suffix
    * @return the string
    */
   @Override
   public String toString(String nodeIdSuffix) {
      return " " + Get.conceptDescriptionText(this.typeConceptSequence) + " <" +
             Get.identifierService().getConceptSequence(this.typeConceptSequence) + ">" + super.toString(nodeIdSuffix);
   }

   /**
    * Compare node fields.
    *
    * @param o the o
    * @return the int
    */
   @Override
   protected final int compareNodeFields(LogicNode o) {
      // node semantic already determined equals.
      final TypedNodeWithSequences other = (TypedNodeWithSequences) o;

      if (this.typeConceptSequence != other.typeConceptSequence) {
         return Integer.compare(this.typeConceptSequence, other.typeConceptSequence);
      }

      return compareTypedNodeFields(o);
   }

   /**
    * Compare typed node fields.
    *
    * @param o the o
    * @return the int
    */
   protected abstract int compareTypedNodeFields(LogicNode o);

   /**
    * Write node data.
    *
    * @param dataOutput the data output
    * @param dataTarget the data target
    * @throws IOException Signals that an I/O exception has occurred.
    */
   @Override
   protected void writeNodeData(DataOutput dataOutput, DataTarget dataTarget)
            throws IOException {
      super.writeData(dataOutput, dataTarget);
      dataOutput.writeInt(this.typeConceptSequence);
   }

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

   /**
    * Gets the only child.
    *
    * @return the only child
    */
   public LogicNode getOnlyChild() {
      final LogicNode[] children = getChildren();

      if (children.length == 1) {
         return children[0];
      }

      throw new IllegalStateException("Typed nodes can have only one child. Found: " + Arrays.toString(children));
   }

   /**
    * Gets the type concept sequence.
    *
    * @return the type concept sequence
    */
   public int getTypeConceptSequence() {
      return this.typeConceptSequence;
   }
}