TaxonomySnapshotService.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.api;

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

import java.util.stream.IntStream;

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

import sh.isaac.api.collections.ConceptSequenceSet;
import sh.isaac.api.tree.Tree;

//~--- interfaces -------------------------------------------------------------

/**
 * The Interface TaxonomySnapshotService.
 *
 * @author kec
 */
public interface TaxonomySnapshotService {
   /**
    * Gets the all relationship destination sequences.
    *
    * @param originId the origin id
    * @return the all relationship destination sequences
    */
   IntStream getAllRelationshipDestinationSequences(int originId);

   /**
    * Gets the all relationship destination sequences of type.
    *
    * @param originId the origin id
    * @param typeSequenceSet the type sequence set
    * @return the all relationship destination sequences of type
    */
   IntStream getAllRelationshipDestinationSequencesOfType(int originId, ConceptSequenceSet typeSequenceSet);

   /**
    * Gets the all relationship origin sequences.
    *
    * @param destination the destination
    * @return the all relationship origin sequences
    */
   IntStream getAllRelationshipOriginSequences(int destination);

   /**
    * Gets the all relationship origin sequences of type.
    *
    * @param destinationId the destination id
    * @param typeSequenceSet the type sequence set
    * @return the all relationship origin sequences of type
    */
   IntStream getAllRelationshipOriginSequencesOfType(int destinationId, ConceptSequenceSet typeSequenceSet);

   /**
    * Checks if child of.
    *
    * @param childId the child id
    * @param parentId the parent id
    * @return true, if child of
    */
   boolean isChildOf(int childId, int parentId);

   /**
    * Checks if kind of.
    *
    * @param childId the child id
    * @param parentId the parent id
    * @return true, if kind of
    */
   boolean isKindOf(int childId, int parentId);

   /**
    * Gets the kind of sequence set.
    *
    * @param rootId the root id
    * @return the kind of sequence set
    */
   ConceptSequenceSet getKindOfSequenceSet(int rootId);

   /**
    * Gets the roots.
    *
    * @return the roots
    */
   IntStream getRoots();

   /**
    * Gets the taxonomy child sequences.
    *
    * @param parentId the parent id
    * @return the taxonomy child sequences
    */
   IntStream getTaxonomyChildSequences(int parentId);

   /**
    * Gets the taxonomy parent sequences.
    *
    * @param childId the child id
    * @return the taxonomy parent sequences
    */
   IntStream getTaxonomyParentSequences(int childId);

   /**
    * Gets the taxonomy tree.
    *
    * @return the taxonomy tree
    */
   Tree getTaxonomyTree();
}