/*
* The MIT License (MIT)
*
* Copyright (c) 2007-2015 Broad Institute
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.broad.igv.bbfile;
import org.apache.log4j.Logger;
/**
* Created by IntelliJ IDEA.
* User: martind
* Date: Dec 20, 2009
* Time: 10:50:26 PM
* To change this template use File | Settings | File Templates.
*/
/*
Container class for B+ Tree child node format
*/
public class BPTreeChildNodeItem implements BPTreeNodeItem {
private static Logger log = Logger.getLogger(BPTreeChildNodeItem.class);
private final boolean isLeafItem = false;
private long itemIndex; // item index in child node list
// B+ Tree Child Node Item entities - BBFile Table H
// Note the childOffset entity is replaced with the actual instance
// of the child note it points to in the file.
private String chromKey; // mChromosome/contig name; of keysize chars
private BPTreeNode childNode; // child node
/*
* Constructs a B+ tree child node item with the supplied information.
*
* Parameters:
* itemIndex - node item index
* chromKey - chromosome name key
* childNode - assigned child node object
* */
public BPTreeChildNodeItem(int itemIndex, String chromKey, BPTreeNode childNode){
this.itemIndex = itemIndex;
this.chromKey = chromKey;
this.childNode = childNode;
}
/*
* Method returns the index assigned to this node item.
*
* Returns:
* index assigned to this node item
* */
public long getItemIndex() {
return itemIndex;
}
/*
* Method returns if this node is a leaf item.
*
* Returns:
* false because node is a child (non-leaf) item
* */
public boolean isLeafItem() {
return isLeafItem;
}
/*
* Method returns the chromosome name key assigned to this node item.
*
* Returns:
* chromosome name key assigned to this node item
* */
public String getChromKey() {
return chromKey;
}
/*
* Method compares supplied chromosome key with leaf node key.
*
* Parameters:
* chromKey - chromosome name ley to compare
*
* Returns:
* true, if keys are equal; false if keys are different
* */
public boolean chromKeysMatch(String chromKey) {
String thisKey = this.chromKey;
String thatKey = chromKey;
// Note: must have the same length to compare chromosome names
int thisKeyLength = thisKey.length();
int thatKeyLength = thatKey.length();
// check if need to truncate the larger string
if(thisKeyLength > thatKeyLength)
thisKey = thisKey.substring(0,thatKeyLength);
else if(thatKeyLength > thisKeyLength)
thatKey = thatKey.substring(0,thisKeyLength);
if (thisKey.compareTo(thatKey) == 0)
return true;
else
return false;
}
public void print() {
log.debug("B+ Tree child node " + itemIndex);
log.debug("Key value = " + chromKey);
// recursively print chid node items
childNode.printItems();
}
// BPTreeLeafNodeItem specific methods
public BPTreeNode getChildNode() {
return childNode;
}
}