/*
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
 * the specific language governing rights and limitations under the License.
 *
 * The Original Code is Protege-2000.
 *
 * The Initial Developer of the Original Code is Stanford University. Portions
 * created by Stanford University are Copyright (C) 2007.  All Rights Reserved.
 *
 * Protege was developed by Stanford Medical Informatics
 * (http://www.smi.stanford.edu) at the Stanford University School of Medicine
 * with support from the National Library of Medicine, the National Science
 * Foundation, and the Defense Advanced Research Projects Agency.  Current
 * information about Protege can be obtained at http://protege.stanford.edu.
 *
 */

package edu.stanford.smi.protege.storage.clips;

import java.io.*;
import java.util.*;

import edu.stanford.smi.protege.model.*;
import edu.stanford.smi.protege.resource.*;
import edu.stanford.smi.protege.util.*;

/**
 * Base class for classes which generate clips files.  This class contains lots of convenience functions.
 *
 * @author    Ray Fergerson <fergerson@smi.stanford.edu>
 */
public abstract class ClipsFileWriter {
    private PrintWriter _writer;

    protected ClipsFileWriter(Writer writer) {
        _writer = new PrintWriter(writer);
        printVersion();
    }

    public void flush() {
        _writer.flush();
    }

    public void print(int i) {
        _writer.print(i);
    }

    public void print(String s) {
        _writer.print(s);
    }

    public void printFrame(Frame frame) {
        _writer.print(toExternalFrameName(frame));
    }

    public void printFrameName(String name) {
        _writer.print(toExternalFrameName(name));
    }

    public void println() {
        _writer.println();
    }

    public void println(String s) {
        _writer.println(s);
    }

    public boolean printSucceeded() {
        return !_writer.checkError();
    }

    private void printVersion() {
        println("; " + new Date().toString());
        println("; ");
        println(";+ (version \"" + Text.getVersion() + "\")");
        println(";+ (build \"" + Text.getBuildInfo() + "\")");
    }

    public static String toExternalFrameName(Frame frame) {
        return toExternalFrameName(frame.getName());
    }

    public static String toExternalFrameName(String internalFrameName) {
        return ClipsUtil.toExternalSymbol(internalFrameName);
    }

    protected static boolean equals(Object o1, Object o2) {
        return SystemUtilities.equals(o1, o2);
    }
}
