Linkable.Analysis
Interface RefLinkAnalyzer

All Known Implementing Classes:

HTMLAnalyzer, XHTMLAnalyzer

public interface RefLinkAnalyzer

Method Summary

java.util.Vector	buildCitationList(java.lang.String docURN)
java.lang.String	buildLocalMetaData(java.lang.String doi, java.lang.String pubDate, Creation c)
Reference[]	buildRefList(BibData b)
java.lang.String	getDate()
java.lang.String	getLinkedText(Reference[] refList, java.lang.String url) getLinkedText emits XML for the linked body of the text and/or the characters of the text body followed by reference-link data suitable for separate presentation.
java.lang.String	getLinkedTextFinalize() getLinkedTextFinalize emits XML for finishing off the Surrogate linked text output.
java.lang.String	getLinkedTextInitialize() getLinkedTextInitialize sets up to generate XML for our Surrogate, but not the incantation.

Method Detail

buildLocalMetaData

public java.lang.String buildLocalMetaData(java.lang.String doi,
                                           java.lang.String pubDate,
                                           Creation c)

buildRefList

public Reference[] buildRefList(BibData b)

buildCitationList

public java.util.Vector buildCitationList(java.lang.String docURN)

getDate

public java.lang.String getDate()

getLinkedTextInitialize

public java.lang.String getLinkedTextInitialize()

getLinkedTextInitialize sets up to generate XML for our Surrogate, but not the incantation.

getLinkedText

public java.lang.String getLinkedText(Reference[] refList,
                                      java.lang.String url)
                               throws SurrogateException

getLinkedText emits XML for the linked body of the text and/or the characters of the text body followed by reference-link data suitable for separate presentation. Note that the reference-link data can be constructed by this routine but saved for output by the getLinkedTextFinalize routine.

Parameters:

The - array of Reference objects belonging to this Surrogate.

the - url of the document, to be used as a Base URL

Throws:

SurrogateException - if the source to be linked cannot be opened.

getLinkedTextFinalize

public java.lang.String getLinkedTextFinalize()

getLinkedTextFinalize emits XML for finishing off the Surrogate linked text output. The main use for this routine is to emit the linkage data elements for documents that are not expressed in HTML or in XHTML.