/*
* 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.UUID;
//~--- 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.api.logic.NodeSemantic;
import sh.isaac.api.util.UuidT5Generator;
import sh.isaac.model.logic.LogicalExpressionOchreImpl;
import sh.isaac.model.logic.node.AbstractLogicNode;
import sh.isaac.model.logic.node.external.TemplateNodeWithUuids;
//~--- classes ----------------------------------------------------------------
/**
* A node that specifies a template to be substituted in place of this node, and
* the assemblage concept that will be used to fill template substitution
* values. Created by kec on 12/10/14.
*/
public final class TemplateNodeWithSequences
extends AbstractLogicNode {
/** Sequence of the concept that defines the template. */
int templateConceptSequence;
/**
* Sequence of the assemblage concept that provides the substitution values
* for the template.
*/
int assemblageConceptSequence;
//~--- constructors --------------------------------------------------------
/**
* Instantiates a new template node with sequences.
*
* @param externalForm the external form
*/
public TemplateNodeWithSequences(TemplateNodeWithUuids externalForm) {
super(externalForm);
this.templateConceptSequence = Get.identifierService()
.getConceptSequenceForUuids(externalForm.getTemplateConceptUuid());
this.assemblageConceptSequence = Get.identifierService()
.getConceptSequenceForUuids(externalForm.getAssemblageConceptUuid());
}
/**
* Instantiates a new template 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 TemplateNodeWithSequences(LogicalExpressionOchreImpl logicGraphVersion,
DataInputStream dataInputStream)
throws IOException {
super(logicGraphVersion, dataInputStream);
this.templateConceptSequence = dataInputStream.readInt();
this.assemblageConceptSequence = dataInputStream.readInt();
}
/**
* Instantiates a new template node with sequences.
*
* @param logicGraphVersion the logic graph version
* @param templateConceptId the template concept id
* @param assemblageConceptId the assemblage concept id
*/
public TemplateNodeWithSequences(LogicalExpressionOchreImpl logicGraphVersion,
int templateConceptId,
int assemblageConceptId) {
super(logicGraphVersion);
this.templateConceptSequence = Get.identifierService()
.getConceptSequence(templateConceptId);
this.assemblageConceptSequence = Get.identifierService()
.getConceptSequence(assemblageConceptId);
}
//~--- methods -------------------------------------------------------------
/**
* Adds the children.
*
* @param children the children
*/
@Override
public final void addChildren(LogicNode... children) {
throw new UnsupportedOperationException();
}
/**
* Adds the concepts referenced by node.
*
* @param conceptSequenceSet the concept sequence set
*/
@Override
public void addConceptsReferencedByNode(ConceptSequenceSet conceptSequenceSet) {
super.addConceptsReferencedByNode(conceptSequenceSet);
conceptSequenceSet.add(this.templateConceptSequence);
conceptSequenceSet.add(this.assemblageConceptSequence);
}
/**
* Equals.
*
* @param o the o
* @return true, if successful
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if ((o == null) || (getClass() != o.getClass())) {
return false;
}
if (!super.equals(o)) {
return false;
}
final TemplateNodeWithSequences that = (TemplateNodeWithSequences) o;
if (this.assemblageConceptSequence != that.assemblageConceptSequence) {
return false;
}
return this.templateConceptSequence == that.templateConceptSequence;
}
/**
* Hash code.
*
* @return the int
*/
@Override
public int hashCode() {
int result = super.hashCode();
result = 31 * result + this.templateConceptSequence;
result = 31 * result + this.assemblageConceptSequence;
return result;
}
/**
* 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 "Template[" + getNodeIndex() + nodeIdSuffix + "] " + "assemblage: " +
Get.conceptDescriptionText(this.assemblageConceptSequence) + ", template: " +
Get.conceptDescriptionText(this.templateConceptSequence) + super.toString(nodeIdSuffix);
}
/**
* Write node data.
*
* @param dataOutput the data output
* @param dataTarget the data target
* @throws IOException Signals that an I/O exception has occurred.
*/
@Override
public void writeNodeData(DataOutput dataOutput, DataTarget dataTarget)
throws IOException {
switch (dataTarget) {
case EXTERNAL:
final TemplateNodeWithUuids externalForm = new TemplateNodeWithUuids(this);
externalForm.writeNodeData(dataOutput, dataTarget);
break;
case INTERNAL:
super.writeData(dataOutput, dataTarget);
dataOutput.writeInt(this.templateConceptSequence);
dataOutput.writeInt(this.assemblageConceptSequence);
break;
default:
throw new UnsupportedOperationException("Can't handle dataTarget: " + dataTarget);
}
}
/**
* Compare fields.
*
* @param o the o
* @return the int
*/
@Override
protected int compareFields(LogicNode o) {
final TemplateNodeWithSequences that = (TemplateNodeWithSequences) o;
if (this.assemblageConceptSequence != that.assemblageConceptSequence) {
return Integer.compare(this.assemblageConceptSequence, that.assemblageConceptSequence);
}
return this.templateConceptSequence - that.templateConceptSequence;
}
/**
* Inits the node uuid.
*
* @return the uuid
*/
@Override
protected UUID initNodeUuid() {
return UuidT5Generator.get(getNodeSemantic().getSemanticUuid(),
Get.identifierService()
.getUuidPrimordialFromConceptId(this.assemblageConceptSequence)
.get()
.toString() + Get.identifierService().getUuidPrimordialFromConceptId(
this.templateConceptSequence).get().toString());
}
//~--- get methods ---------------------------------------------------------
/**
* Gets the sequence of the assemblage concept that provides the substitution values for the template.
*
* @return the sequence of the assemblage concept that provides the substitution values for the template
*/
public int getAssemblageConceptSequence() {
return this.assemblageConceptSequence;
}
/**
* Gets the children.
*
* @return the children
*/
@Override
public final AbstractLogicNode[] getChildren() {
return new AbstractLogicNode[0];
}
/**
* Gets the node semantic.
*
* @return the node semantic
*/
@Override
public NodeSemantic getNodeSemantic() {
return NodeSemantic.TEMPLATE;
}
/**
* Gets the sequence of the concept that defines the template.
*
* @return the sequence of the concept that defines the template
*/
public int getTemplateConceptSequence() {
return this.templateConceptSequence;
}
}