source: trunk/gsdl3/src/java/org/greenstone/gsdl3/util/OID.java@ 3308

package org.greenstone.gsdl3.util;

/** utitility class to handle greenstone OIDs
 *
 * based around OIDtools.h from gsdl
 */
public class OID {
    
    /** returns everything up to the first dot 
    if no dot, returns oid */
    public static String getTop(String oid) {
    int pos = oid.indexOf('.');
    if (pos == -1) {
        return oid;
    }
    return oid.substring(0, pos);
    
    }
    /** returns true is oid is top level (ie has no dots) 
     returns false for an empty oid */
    public static boolean isTop(String oid) {
    if (oid.equals("")) {
        return false;
    }
    return (oid.indexOf('.')==-1);
    }
    
    /** returns the parent of oid (everything up to last dot) 
     returns "" if oid has no parent */
    public static String getParent(String oid) {
    int pos = oid.lastIndexOf('.');
    if (pos == -1) {
        return "";
    }
    return oid.substring(0, pos);
    }

    /** returns the full name - replaces " with parent */
    public static String translateParent(String oid, String parent) {
    // this is the behaviour of the original - should only replace first
    //perhaps?
    return oid.replaceAll("\"", parent); 
    }
    /** does the opposite to translate_parent */
    public static String shrinkParent(String oid) {
    int pos = oid.lastIndexOf('.');
    if (pos==-1) return oid;
    return "\""+oid.substring(pos);
    }
    /** returns true if oid uses .fc, .lc, .pr, .ns, .ps */
    public static boolean needsTranslating(String oid) {
    String tail = oid.substring(oid.length()-3);
    return (tail.equals(".fc") || tail.equals(".lc") || tail.equals(".pr")
        || tail.equals(".ns") || tail.equals(".ps"));
    }
    /** strips suffix from end */
    public static String stripSuffix(String oid) {
    String tail = oid.substring(oid.length()-3);
    while (tail.equals(".fc") || tail.equals(".lc") || tail.equals(".pr")
           || tail.equals(".ns") || tail.equals(".ps")) {
        oid = oid.substring(0, oid.length()-3);
        tail = oid.substring(oid.length()-3);
    }
    return oid;
    }
    /** returns true if child is a child of parent 
     an oid is not a child of itself */
    public static boolean isChildOf(String parent, String child) {
    if (parent.equals(child)) {
        return false;
    }
    return child.startsWith(parent);
    }
}