edu.ucla.sspace.text

Class LabeledStringDocument

java.lang.Object

edu.ucla.sspace.text.StringDocument

edu.ucla.sspace.text.LabeledStringDocument

All Implemented Interfaces:

Document, LabeledDocument

Direct Known Subclasses:

LabeledParsedStringDocument

public class LabeledStringDocument
extends StringDocument
implements LabeledDocument

A LabeledDocument implementation backed by a String whose contents are used for the document text.

Constructor Summary

Constructors

Constructor and Description
LabeledStringDocument(String label, String docText) Constructs a Document using the provided string as the document text

Method Summary

Methods

Modifier and Type	Method and Description
String	label() Returns a label associated with this particular document.

Methods inherited from class edu.ucla.sspace.text.StringDocument

reader, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface edu.ucla.sspace.text.Document

reader

Constructor Detail

LabeledStringDocument

public LabeledStringDocument(String label,
                     String docText)

Constructs a Document using the provided string as the document text

Parameters:

docText - the document text

Method Detail

label

public String label()

Returns a label associated with this particular document. The label is intended to provide information on the source of the document or the contents therein.

Specified by:

label in interface LabeledDocument