|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.lint.LintContext
public class LintContext
Context for a VOTLint process. This is the object which knows most of the available global information about the parse. It also provides facilities for reporting log information about the parse to the user.
Field Summary | |
---|---|
static int |
MAX_REPEAT
Maximum number of identical error messages which will be logged. |
static String |
V10
VOTABLE element version attribute value representing version 1.0. |
static String |
V11
VOTABLE element version attribute value representing version 1.1. |
static String[] |
VOT_VERSIONS
VOTable element version values representing known versions. |
Constructor Summary | |
---|---|
LintContext()
Constructor for unknown VOTable version. |
|
LintContext(String version)
Constructs a LintContext to parse documents with a given VOTable version. |
Method Summary | |
---|---|
ElementHandler |
createHandler(String localName)
Constructs a new ElementHandler for a given local element name. |
void |
error(String msg)
Write an error message to the user. |
Map |
getAttributeCheckers(String localName)
Returns a map of attribute checkers suitable for processing elements of a given name. |
Locator |
getLocator()
Returns the SAX document locator for this parse. |
Map |
getNamespaceMap()
Returns prefix->namespaceURI map for the xmlns namespaces currently in scope. |
PrintStream |
getOutput()
Returns the output stream to which messages will be written. |
String |
getVersion()
Returns the version of VOTable this context is parsing. |
void |
info(String msg)
Write an informative message to the user. |
boolean |
isDebug()
Returns whether we are in debug mode. |
boolean |
isValidating()
Indicates whether this lint is validating. |
void |
message(String type,
String msg,
Throwable e)
Dispatches a message to the user. |
void |
registerID(String id,
ElementHandler handler)
Register the fact that an XML ID-type attribute has been seen on an element. |
void |
registerRef(String id,
ElementRef from,
RefChecker checker)
Register the fact that an XML IDREF-type attribute has been seen on an element. |
void |
reportUncheckedRefs()
Goes through all the unresolved IDREF->ID arcs and reports them. |
void |
setDebug(boolean debug)
Sets whether we are in debug mode. |
void |
setLocator(Locator locator)
Sets the SAX document locator for this parse. |
void |
setOutput(PrintStream out)
Sets the output stream to which messages will be written. |
void |
setValidating(boolean validate)
Sets whether this lint is validating. |
void |
setVersion(String version)
Sets the version we are parsing to a given value. |
void |
warning(String msg)
Write a warning message to the user. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String V10
public static final String V11
public static final String[] VOT_VERSIONS
public static final int MAX_REPEAT
Constructor Detail |
---|
public LintContext()
public LintContext(String version)
version
- version string (currently "1.0" or "1.1")Method Detail |
---|
public String getVersion()
public void setVersion(String version)
version
- version string (currently "1.0" or "1.1")public void setValidating(boolean validate)
validate
- true for validating lintpublic boolean isValidating()
public void setLocator(Locator locator)
locator
- locatorpublic Locator getLocator()
public void setDebug(boolean debug)
debug
- true iff you want debugging outputpublic boolean isDebug()
public PrintStream getOutput()
public void setOutput(PrintStream out)
out
- output streampublic ElementHandler createHandler(String localName)
localName
- element name
public Map getAttributeCheckers(String localName)
localName
- element name
public Map getNamespaceMap()
public void registerID(String id, ElementHandler handler)
id
- ID valuehandler
- element labelled idpublic void registerRef(String id, ElementRef from, RefChecker checker)
id
- ID valuefrom
- the element on which the ref has been seenchecker
- the checker which knows how to check links of this
typepublic void reportUncheckedRefs()
public void info(String msg)
msg
- messagepublic void warning(String msg)
msg
- messagepublic void error(String msg)
msg
- messagepublic void message(String type, String msg, Throwable e)
type
- indication of message severitymsg
- specific message contente
- throwable associated with this message
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |