edu.stanford.nlp.simple

Class Document

java.lang.Object

edu.stanford.nlp.simple.Document

Direct Known Subclasses:

ArabicDocument, ChineseDocument, FrenchDocument, GermanDocument, SpanishDocument

public class Document
extends java.lang.Object

A representation of a Document. Most blobs of raw text should become documents.

Author:

Gabor Angeli

Field Summary

Fields

Modifier and Type	Field and Description
protected CoreNLPProtos.Document.Builder	impl The protocol buffer representing this document
protected java.util.List<Sentence>	sentences The list of sentences associated with this document
protected ProtobufAnnotationSerializer	serializer A serializer to assist in serializing and deserializing from Protocol buffers

Constructor Summary

Constructors

Constructor and Description
Document(Annotation ann)
Document(CoreNLPProtos.Document proto)
Document(java.util.Properties props, Annotation ann) Convert a CoreNLP Annotation object to a Document.
Document(java.util.Properties props, CoreNLPProtos.Document proto) Create a Document object from a read Protocol Buffer.
Document(java.util.Properties props, java.lang.String text) Create a new document from the passed in text and the given properties.
Document(java.lang.String text) Create a new document from the passed in text.

Method Summary

Modifier and Type	Method and Description
Annotation	asAnnotation() Return this Document as an Annotation object.
Document	cased() Make this document case sensitive.
Document	caseless() Make this document caseless.
java.util.Map<java.lang.Integer,CorefChain>	coref()
java.util.Map<java.lang.Integer,CorefChain>	coref(java.util.Properties props) Returns the coref chains in the document.
static Document	deserialize(java.io.InputStream in) Read a document from an input stream.
java.util.Optional<java.lang.String>	docid() Returns the document id of the document, if one was found
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	json(java.util.function.Function<Sentence,java.lang.Object>... functions) Write this annotation as a JSON string.
java.lang.String	jsonMinified(java.util.function.Function<Sentence,java.lang.Object>... functions) Like the Document@json(Function...) function, but with minified JSON more suitable for sending over the wire.
Sentence	sentence(int sentenceIndex)
Sentence	sentence(int sentenceIndex, java.util.Properties props)
java.util.List<Sentence>	sentences()
java.util.List<Sentence>	sentences(java.util.Properties props) Get the sentences in this document, as a list.
protected java.util.List<Sentence>	sentences(java.util.Properties props, Annotator tokenizer) Get the sentences in this document, as a list.
CoreNLPProtos.Document	serialize() Serialize this Document as a Protocol Buffer.
void	serialize(java.io.OutputStream out) Write this document to an output stream.
static void	setBackend(AnnotatorImplementations backend) Set the backend implementations for our CoreNLP pipeline.
Document	setDocid(java.lang.String docid) Sets the document id of the document, returning this.
java.lang.String	text() Get the raw text of the document, as input by, e.g., Document(String).
java.lang.String	toString()
static void	useServer(java.lang.String host, int port) Use the CoreNLP Server (StanfordCoreNLPServer) for the heavyweight backend annotation job.
static void	useServer(java.lang.String host, int port, java.lang.String apiKey, java.lang.String apiSecret, boolean lazy) Use the CoreNLP Server (StanfordCoreNLPServer) for the heavyweight backend annotation job, authenticating with the given credentials.
static void	useServer(java.lang.String host, java.lang.String apiKey, java.lang.String apiSecret)
static void	useServer(java.lang.String host, java.lang.String apiKey, java.lang.String apiSecret, boolean lazy)
java.lang.String	xml(java.util.function.Function<Sentence,java.lang.Object>... functions) Write this annotation as an XML string.
java.lang.String	xmlMinified(java.util.function.Function<Sentence,java.lang.Object>... functions) Like the Document@xml(Function...) function, but with minified XML more suitable for sending over the wire.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

impl

protected final CoreNLPProtos.Document.Builder impl

The protocol buffer representing this document

sentences

protected java.util.List<Sentence> sentences

The list of sentences associated with this document

serializer

protected final ProtobufAnnotationSerializer serializer

A serializer to assist in serializing and deserializing from Protocol buffers

Constructor Detail

Document

public Document(java.util.Properties props,
                java.lang.String text)

Create a new document from the passed in text and the given properties.

Parameters:

text - The text of the document.

Document

public Document(java.lang.String text)

Create a new document from the passed in text.

Parameters:

text - The text of the document.

Document

public Document(java.util.Properties props,
                Annotation ann)

Convert a CoreNLP Annotation object to a Document.

Parameters:

ann - The CoreNLP Annotation object.

Document

public Document(Annotation ann)

See Also:

Document(Properties, Annotation)

Document

public Document(java.util.Properties props,
                CoreNLPProtos.Document proto)

Create a Document object from a read Protocol Buffer.

Parameters:

proto - The protocol buffer representing this document.

See Also:

serialize()

Document

public Document(CoreNLPProtos.Document proto)

See Also:

Document(Properties, CoreNLPProtos.Document)

Method Detail

setBackend

public static void setBackend(AnnotatorImplementations backend)

Set the backend implementations for our CoreNLP pipeline. For example, to a ServerAnnotatorImplementations.

Parameters:

backend - The backend to use from now on for annotating documents.

useServer

public static void useServer(java.lang.String host,
                             int port)

Use the CoreNLP Server (StanfordCoreNLPServer) for the heavyweight backend annotation job.

Parameters:

host - The hostname of the server.

port - The port the server is running on.

useServer

public static void useServer(java.lang.String host,
                             int port,
                             java.lang.String apiKey,
                             java.lang.String apiSecret,
                             boolean lazy)

Use the CoreNLP Server (StanfordCoreNLPServer) for the heavyweight backend annotation job, authenticating with the given credentials.

Parameters:

host - The hostname of the server.

port - The port the server is running on.

apiKey - The api key to use as the username for authentication

apiSecret - The api secrete to use as the password for authentication

lazy - Only run the annotations that are required at this time. If this is false, we will also run a bunch of standard annotations, to cut down on expected number of round-trips.

useServer

public static void useServer(java.lang.String host,
                             java.lang.String apiKey,
                             java.lang.String apiSecret,
                             boolean lazy)

See Also:

useServer(String, int, String, String, boolean)

useServer

public static void useServer(java.lang.String host,
                             java.lang.String apiKey,
                             java.lang.String apiSecret)

See Also:

useServer(String, int, String, String, boolean)

caseless

public Document caseless()

Make this document caseless. That is, from now on, run the caseless models on the document by default rather than the standard CoreNLP models.

Returns:

This same document, but with the default properties swapped out.

cased

public Document cased()

Make this document case sensitive. A document is case sensitive by default; this only has an effect if you have previously called Sentence.caseless().

Returns:

This same document, but with the default properties swapped out.

serialize

public CoreNLPProtos.Document serialize()

Serialize this Document as a Protocol Buffer. This can be deserialized with the constructor Document(edu.stanford.nlp.pipeline.CoreNLPProtos.Document).

Returns:

The document as represented by a Protocol Buffer.

serialize

public void serialize(java.io.OutputStream out)
               throws java.io.IOException

Write this document to an output stream. Internally, this stores the document as a protocol buffer, and saves that buffer to the output stream. This method does not close the stream after writing.

Parameters:

out - The output stream to write to. The stream is not closed after the method returns.

Throws:

java.io.IOException - Thrown from the underlying write() implementation.

See Also:

deserialize(InputStream)

deserialize

public static Document deserialize(java.io.InputStream in)
                            throws java.io.IOException

Read a document from an input stream. This does not close the input stream.

Parameters:

in - The input stream to deserialize from.

Returns:

The next document encoded in the input stream.

Throws:

java.io.IOException - Thrown by the underlying parse() implementation.

See Also:

serialize(java.io.OutputStream)

json

@SafeVarargs
public final java.lang.String json(java.util.function.Function<Sentence,java.lang.Object>... functions)

Write this annotation as a JSON string. Optionally, you can also specify a number of operations to call on the document before dumping it to JSON. This allows the user to ensure that certain annotations have been computed before the document is dumped. For example:

   String json = new Document("Lucy in the sky with diamonds").json(Sentence::parse, Sentence::ner);
 

will create a JSON dump of the document, ensuring that at least the parse tree and ner tags are populated.

Parameters:

functions - The (possibly empty) list of annotations to populate on the document before dumping it to JSON.

Returns:

The JSON String for this document.

jsonMinified

@SafeVarargs
public final java.lang.String jsonMinified(java.util.function.Function<Sentence,java.lang.Object>... functions)

Like the Document@json(Function...) function, but with minified JSON more suitable for sending over the wire.

Parameters:

functions - The (possibly empty) list of annotations to populate on the document before dumping it to JSON.

Returns:

The JSON String for this document, without unnecessary whitespace.

xml

@SafeVarargs
public final java.lang.String xml(java.util.function.Function<Sentence,java.lang.Object>... functions)

Write this annotation as an XML string. Optionally, you can also specify a number of operations to call on the document before dumping it to XML. This allows the user to ensure that certain annotations have been computed before the document is dumped. For example:

String xml = new Document("Lucy in the sky with diamonds").xml(Document::parse, Document::ner);

will create a XML dump of the document, ensuring that at least the parse tree and ner tags are populated.

Parameters:

functions - The (possibly empty) list of annotations to populate on the document before dumping it to XML.

Returns:

The XML String for this document.

xmlMinified

@SafeVarargs
public final java.lang.String xmlMinified(java.util.function.Function<Sentence,java.lang.Object>... functions)

Like the Document@xml(Function...) function, but with minified XML more suitable for sending over the wire.

Parameters:

functions - The (possibly empty) list of annotations to populate on the document before dumping it to XML.

Returns:

The XML String for this document, without unecessary whitespace.

sentences

public java.util.List<Sentence> sentences(java.util.Properties props)

Get the sentences in this document, as a list.

Parameters:

props - The properties to use in the WordsToSentencesAnnotator.

Returns:

A list of Sentence objects representing the sentences in the document.

sentences

protected java.util.List<Sentence> sentences(java.util.Properties props,
                                             Annotator tokenizer)

Get the sentences in this document, as a list.

Parameters:

props - The properties to use in the WordsToSentencesAnnotator.

Returns:

A list of Sentence objects representing the sentences in the document.

sentences

public java.util.List<Sentence> sentences()

See Also:

sentences(java.util.Properties)

sentence

public Sentence sentence(int sentenceIndex,
                         java.util.Properties props)

See Also:

sentences(java.util.Properties)

sentence

public Sentence sentence(int sentenceIndex)

See Also:

sentences(java.util.Properties)

text

public java.lang.String text()

Get the raw text of the document, as input by, e.g., Document(String).

coref

public java.util.Map<java.lang.Integer,CorefChain> coref(java.util.Properties props)

Returns the coref chains in the document. This is a map from coref cluster IDs, to the coref chain with that ID.

Parameters:

props - The properties to use in the DeterministicCorefAnnotator.

coref

public java.util.Map<java.lang.Integer,CorefChain> coref()

See Also:

coref(java.util.Properties)

docid

public java.util.Optional<java.lang.String> docid()

Returns the document id of the document, if one was found

setDocid

public Document setDocid(java.lang.String docid)

Sets the document id of the document, returning this.

asAnnotation

public Annotation asAnnotation()

Return this Document as an Annotation object. Note that, importantly, only the fields which have already been called will be populated in the Annotation!

Therefore, this method is generally NOT recommended.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object