package com.nwalsh.xalan;
import org.w3c.dom.*;
/**
*
Utility class for the Verbatim extension (ignore this).
*
* $Id: Callout.java,v 1.1 2001/04/02 13:03:45 nwalsh Exp $
*
* Copyright (C) 2000 Norman Walsh.
*
* This class is just for book keeping in the Verbatim class.
* It stores information about the location of callouts.
*
* Only line/column based callouts are supported. This class
* implements the Comparable interface so that callouts can be sorted.
* Callouts are sorted so that they occur in left-to-right,
* top-to-bottom order based on line/column.
*
* Change Log:
*
* - 1.0
* Initial release.
*
*
* @author Norman Walsh
* ndw@nwalsh.com
*
* @see Verbatim
*
* @version $Id: Callout.java,v 1.1 2001/04/02 13:03:45 nwalsh Exp $
* */
public class Callout implements Comparable {
/** The callout number. */
private int callout = 0;
/** The area Element item that generated this callout. */
private Element area = null;
/** The line on which this callout occurs. */
private int line = 0;
/** The column in which this callout appears. */
private int col = 0;
/** The type of callout. */
private int type = 0;
/** The other type of callout. */
private String otherType = null;
public static final int CALS_PAIR = 1;
public static final int LINE_COLUMN = 2;
public static final int LINE_COLUMN_PAIR = 3;
public static final int LINE_RANGE = 4;
public static final int OTHER = 5;
/** The constructor; initialize the private data structures. */
public Callout(int callout, Element area, int line, int col, int type) {
this.callout = callout;
this.area = area;
this.line = line;
this.col = col;
this.type = type;
this.otherType = null;
}
/** The constructor; initialize the private data structures. */
public Callout(int callout, Element area, int line, int col, String otherType) {
this.callout = callout;
this.area = area;
this.line = line;
this.col = col;
this.type = Callout.OTHER;
this.otherType = otherType;
}
/**
* The compareTo method compares this Callout with another.
*
* Given two Callouts, A and B, A < B if:
*
*
* - A.line < B.line, or
* - A.line = B.line && A.col < B.col, or
* - A.line = B.line && A.col = B.col && A.callout < B.callout
* - Otherwise, they're equal.
*
*/
public int compareTo (Object o) {
Callout c = (Callout) o;
if (line == c.getLine()) {
if (col > c.getColumn()) {
return 1;
} else if (col < c.getColumn()) {
return -1;
} else {
if (callout < c.getCallout()) {
return -1;
} else if (callout > c.getCallout()) {
return 1;
} else {
return 0;
}
}
} else {
if (line > c.getLine()) {
return 1;
} else {
return -1;
}
}
}
/** Access the Callout's area. */
public Element getArea() {
return area;
}
/** Access the Callout's line. */
public int getLine() {
return line;
}
/** Access the Callout's column. */
public int getColumn() {
return col;
}
/** Access the Callout's callout number. */
public int getCallout() {
return callout;
}
/** Access the Callout's type. */
public int getType() {
return type;
}
/** Access the Callout's otherType. */
public String getOtherType() {
return otherType;
}
}