net.sourceforge.nite.util
Class HTMLCorpusVisualiser

java.lang.Object
  net.sourceforge.nite.util.HTMLCorpusVisualiser

All Implemented Interfaces:

CorpusVisualiser

public class HTMLCorpusVisualiser
extends java.lang.Object
implements CorpusVisualiser

Produce a set of HTML files as a description of the provided corpus.

Author:

Jonathan Kilgour, UEdin

Constructor Summary

HTMLCorpusVisualiser(NMetaData meta, java.lang.String outputdir, boolean showcontent)
main constructor - can be called from other programs this way.

Method Summary

java.lang.Object	getVisualisationObject() return a handle to the top-level visualisation object: an HTML file / text file / graphical object depending on the mode of the visualisation.
void	visualiseCorpus() perform visualisation and make ready for viewing
void	writeAnnotationElementFile(NFile coding, NLayer layer, NElement element, int eltype, java.lang.String extraatts) write a file for an individual annotation element
void	writeCSSFile(java.lang.String filename)
void	writeOntologyFile(NOntology ontology, java.lang.String extraatts) write a file for an ontology

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTMLCorpusVisualiser

public HTMLCorpusVisualiser(NMetaData meta,
                            java.lang.String outputdir,
                            boolean showcontent)

main constructor - can be called from other programs this way. Valid parameters are

• meta NMetaData - metadata file from existing corpus
• outputdir String - name the output directory into which results are written (may be null for GRAPHICAL mode output).
• showcontent boolean - if true (default is false) show, or link to, actual corpus coverage data

Method Detail

visualiseCorpus

public void visualiseCorpus()

perform visualisation and make ready for viewing

Specified by:

visualiseCorpus in interface CorpusVisualiser

writeOntologyFile

public void writeOntologyFile(NOntology ontology,
                              java.lang.String extraatts)

write a file for an ontology

writeAnnotationElementFile

public void writeAnnotationElementFile(NFile coding,
                                       NLayer layer,
                                       NElement element,
                                       int eltype,
                                       java.lang.String extraatts)

write a file for an individual annotation element

getVisualisationObject

public java.lang.Object getVisualisationObject()

return a handle to the top-level visualisation object: an HTML file / text file / graphical object depending on the mode of the visualisation.

Specified by:

getVisualisationObject in interface CorpusVisualiser

writeCSSFile

public void writeCSSFile(java.lang.String filename)