AnnotatedNYTDocument (annotated-nyt 1.1.3 API)

java.lang.Object
- edu.jhu.hlt.annotatednyt.AnnotatedNYTDocument

```
public class AnnotatedNYTDocument
extends Object
```
Wrapper for the NYTCorpusDocument object, providing some extra utility.

In this wrapper, the semantics of possibly empty fields are represented by Optional wrappers. Methods that return an Optional object represent fields that can be null in the Annotated NYT corpus. Methods that return an object directly (e.g., String, Integer etc.) are guaranteed to be non-null across the corpus.

This wrapper also provides List objects, for convenience, for many fields. The semantics of these lists is as follows: the list is guaranteed to be non-null, but the list might be empty if the underlying corpus document does not have content for the field specified.

Constructor Summary

Constructors
Constructor and Description

AnnotatedNYTDocument(NYTCorpusDocument nytdoc)
Wrap an NYTCorpusDocument object.

Constructors
Constructor and Description
`AnnotatedNYTDocument(NYTCorpusDocument nytdoc)` Wrap an `NYTCorpusDocument` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<URL>`	`getAlternateURL()`
`Optional<String>`	`getArticleAbstract()`
`Optional<String>`	`getAuthorBiography()`
`Optional<String>`	`getBanner()`
`List<String>`	`getBiographicalCategories()`
`List<String>`	`getBodyAsList()`
`Optional<String>`	`getByline()`
`Optional<String>`	`getColumnName()`
`Optional<Integer>`	`getColumnNumber()` Accessor for the columnNumber property.
`Optional<Date>`	`getCorrectionDate()` Accessor for the correctionDate property.
`Optional<String>`	`getCorrectionText()`
`String`	`getCredit()` Accessor for the credit property.
`Optional<String>`	`getDateline()`
`Optional<String>`	`getDayOfWeek()` Accessor for the dayOfWeek property.
`List<String>`	`getDescriptors()`
`Optional<String>`	`getFeaturePage()` Accessor for the featurePage property.
`List<String>`	`getGeneralOnlineDescriptors()` Accessor for the generalOnlineDescriptors property.
`Integer`	`getGuid()`
`Optional<String>`	`getHeadline()`
`Optional<String>`	`getKicker()`
`Optional<String>`	`getLeadParagraph()`
`List<String>`	`getLeadParagraphAsList()`
`List<String>`	`getLocations()` Accessor for the locations property.
`List<String>`	`getNames()` Accessor for the names property.
`Optional<String>`	`getNewsDesk()` Accessor for the newsDesk property.
`Optional<String>`	`getNormalizedByline()` Accessor for the normalizedByline property.
`List<String>`	`getOnlineDescriptors()` Accessor for the onlineDescriptors property.
`Optional<String>`	`getOnlineHeadline()`
`Optional<String>`	`getOnlineLeadParagraph()`
`List<String>`	`getOnlineLeadParagraphAsList()`
`List<String>`	`getOnlineLocations()` Accessor for the onlineLocations property.
`List<String>`	`getOnlineOrganizations()` Accessor for the onlineOrganizations property.
`List<String>`	`getOnlinePeople()` Accessor for the onlinePeople property.
`Optional<String>`	`getOnlineSection()` Accessor for the onlineSection property.
`List<String>`	`getOnlineSectionAsList()`
`List<String>`	`getOnlineTitles()` Accessor for the onlineTitles property.
`List<String>`	`getOrganizations()` Accessor for the organizations property.
`Optional<Integer>`	`getPage()` Accessor for the page property.
`List<String>`	`getPeople()` Accessor for the people property.
`Optional<Date>`	`getPublicationDate()` Accessor for the publicationDate property.
`Optional<Integer>`	`getPublicationDayOfMonth()` Accessor for the publicationDayOfMonth property.
`Optional<Integer>`	`getPublicationMonth()` Accessor for the publicationMonth property.
`Optional<Integer>`	`getPublicationYear()` Accessor for the publicationYear property.
`Optional<String>`	`getSection()` Accessor for the section property.
`Optional<String>`	`getSeriesName()` Accessor for the seriesName property.
`Optional<String>`	`getSlug()` Accessor for the slug property.
`Optional<Path>`	`getSourcePath()` Accessor for the sourceFile property.
`List<String>`	`getTaxonomicClassifiers()` Accessor for the taxonomicClassifiers property.
`List<String>`	`getTitles()` Accessor for the titles property.
`List<String>`	`getTypesOfMaterial()` Accessor for the typesOfMaterial property.
`Optional<URL>`	`getUrl()` Accessor for the url property.
`Optional<Integer>`	`getWordCount()` Accessor for the wordCount property.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AnnotatedNYTDocument
```
public AnnotatedNYTDocument(NYTCorpusDocument nytdoc)
```
    Wrap an NYTCorpusDocument object.
    
    Parameters:
    
    nytdoc - the NYTCorpusDocument to wrap
- Method Detail
  - getGuid
```
public Integer getGuid()
```
    Returns:
    
    the guid of the underlying document as an Integer. Guaranteed non-null.
  - getOnlineSectionAsList
```
public List<String> getOnlineSectionAsList()
```
    Returns:
    
    the online section field as a list. It is split by the ; delimeter.
  - getLeadParagraphAsList
```
public List<String> getLeadParagraphAsList()
```
    Returns:
    
    the lead paragraph field as a list. Split by *nix newlines.
  - getOnlineLeadParagraphAsList
```
public List<String> getOnlineLeadParagraphAsList()
```
    Returns:
    
    the online lead paragraph field as a list, split by *nix newlines.
  - getBodyAsList
```
public List<String> getBodyAsList()
```
    Returns:
    
    the body field as a list, split by *nix newlines.
  - getHeadline
```
public Optional<String> getHeadline()
```
    Returns:
    
    the headline
  - getOnlineHeadline
```
public Optional<String> getOnlineHeadline()
```
    Returns:
    
    the online headline
  - getByline
```
public Optional<String> getByline()
```
    Returns:
    
    the byline
  - getDateline
```
public Optional<String> getDateline()
```
    Returns:
    
    the dateline as a string
  - getArticleAbstract
```
public Optional<String> getArticleAbstract()
```
    Returns:
    
    the article abstract
  - getLeadParagraph
```
public Optional<String> getLeadParagraph()
```
    Returns:
    
    the lead paragraph
  - getOnlineLeadParagraph
```
public Optional<String> getOnlineLeadParagraph()
```
    Returns:
    
    the online lead paragraph
  - getCorrectionText
```
public Optional<String> getCorrectionText()
```
    Returns:
    
    the correction text
  - getKicker
```
public Optional<String> getKicker()
```
    Returns:
    
    the kicker
  - getAlternateURL
```
public Optional<URL> getAlternateURL()
```
    Returns:
    
    the alternate url, as a URL object.
  - getDescriptors
```
public List<String> getDescriptors()
```
    Returns:
    
    the descriptors
  - getAuthorBiography
```
public Optional<String> getAuthorBiography()
```
    Returns:
    
    the author biography
  - getBanner
```
public Optional<String> getBanner()
```
    Returns:
    
    the banner
  - getBiographicalCategories
```
public List<String> getBiographicalCategories()
```
    Returns:
    
    the biographical categories, as a list. May be empty.
  - getColumnName
```
public Optional<String> getColumnName()
```
    Returns:
    
    the column name
  - getColumnNumber
```
public Optional<Integer> getColumnNumber()
```
    Accessor for the columnNumber property.
    
    Returns:
    
    the columnNumber
  - getCorrectionDate
```
public Optional<Date> getCorrectionDate()
```
    Accessor for the correctionDate property.
    
    Returns:
    
    the correctionDate
  - getCredit
```
public String getCredit()
```
    Accessor for the credit property.
    
    Returns:
    
    the credit
  - getDayOfWeek
```
public Optional<String> getDayOfWeek()
```
    Accessor for the dayOfWeek property.
    
    Returns:
    
    the dayOfWeek
  - getFeaturePage
```
public Optional<String> getFeaturePage()
```
    Accessor for the featurePage property.
    
    Returns:
    
    the featurePage
  - getGeneralOnlineDescriptors
```
public List<String> getGeneralOnlineDescriptors()
```
    Accessor for the generalOnlineDescriptors property.
    
    Returns:
    
    the generalOnlineDescriptors
  - getLocations
```
public List<String> getLocations()
```
    Accessor for the locations property.
    
    Returns:
    
    the locations
  - getNames
```
public List<String> getNames()
```
    Accessor for the names property.
    
    Returns:
    
    the names
  - getNewsDesk
```
public Optional<String> getNewsDesk()
```
    Accessor for the newsDesk property.
    
    Returns:
    
    the newsDesk
  - getNormalizedByline
```
public Optional<String> getNormalizedByline()
```
    Accessor for the normalizedByline property.
    
    Returns:
    
    the normalizedByline
  - getOnlineDescriptors
```
public List<String> getOnlineDescriptors()
```
    Accessor for the onlineDescriptors property.
    
    Returns:
    
    the onlineDescriptors
  - getOnlineLocations
```
public List<String> getOnlineLocations()
```
    Accessor for the onlineLocations property.
    
    Returns:
    
    the onlineLocations
  - getOnlineOrganizations
```
public List<String> getOnlineOrganizations()
```
    Accessor for the onlineOrganizations property.
    
    Returns:
    
    the onlineOrganizations
  - getOnlinePeople
```
public List<String> getOnlinePeople()
```
    Accessor for the onlinePeople property.
    
    Returns:
    
    the onlinePeople
  - getOnlineSection
```
public Optional<String> getOnlineSection()
```
    Accessor for the onlineSection property.
    
    Returns:
    
    the onlineSection
  - getOnlineTitles
```
public List<String> getOnlineTitles()
```
    Accessor for the onlineTitles property.
    
    Returns:
    
    the onlineTitles
  - getOrganizations
```
public List<String> getOrganizations()
```
    Accessor for the organizations property.
    
    Returns:
    
    the organizations
  - getPage
```
public Optional<Integer> getPage()
```
    Accessor for the page property.
    
    Returns:
    
    the page
  - getPeople
```
public List<String> getPeople()
```
    Accessor for the people property.
    
    Returns:
    
    the people
  - getPublicationDate
```
public Optional<Date> getPublicationDate()
```
    Accessor for the publicationDate property.
    
    Returns:
    
    the publicationDate
  - getPublicationDayOfMonth
```
public Optional<Integer> getPublicationDayOfMonth()
```
    Accessor for the publicationDayOfMonth property.
    
    Returns:
    
    the publicationDayOfMonth
  - getPublicationMonth
```
public Optional<Integer> getPublicationMonth()
```
    Accessor for the publicationMonth property.
    
    Returns:
    
    the publicationMonth
  - getPublicationYear
```
public Optional<Integer> getPublicationYear()
```
    Accessor for the publicationYear property.
    
    Returns:
    
    the publicationYear
  - getSection
```
public Optional<String> getSection()
```
    Accessor for the section property.
    
    Returns:
    
    the section
  - getSeriesName
```
public Optional<String> getSeriesName()
```
    Accessor for the seriesName property.
    
    Returns:
    
    the seriesName
  - getSlug
```
public Optional<String> getSlug()
```
    Accessor for the slug property.
    
    Returns:
    
    the slug
  - getSourcePath
```
public Optional<Path> getSourcePath()
```
    Accessor for the sourceFile property.
    
    Returns:
    
    the sourceFile
  - getTaxonomicClassifiers
```
public List<String> getTaxonomicClassifiers()
```
    Accessor for the taxonomicClassifiers property.
    
    Returns:
    
    the taxonomicClassifiers
  - getTitles
```
public List<String> getTitles()
```
    Accessor for the titles property.
    
    Returns:
    
    the titles
  - getTypesOfMaterial
```
public List<String> getTypesOfMaterial()
```
    Accessor for the typesOfMaterial property.
    
    Returns:
    
    the typesOfMaterial
  - getUrl
```
public Optional<URL> getUrl()
```
    Accessor for the url property.
    
    Returns:
    
    the url
  - getWordCount
```
public Optional<Integer> getWordCount()
```
    Accessor for the wordCount property.
    
    Returns:
    
    the wordCount
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AnnotatedNYTDocument

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnnotatedNYTDocument

Method Detail

getGuid

getOnlineSectionAsList

getLeadParagraphAsList

getOnlineLeadParagraphAsList

getBodyAsList

getHeadline

getOnlineHeadline

getByline

getDateline

getArticleAbstract

getLeadParagraph

getOnlineLeadParagraph

getCorrectionText

getKicker

getAlternateURL

getDescriptors

getAuthorBiography

getBanner

getBiographicalCategories

getColumnName

getColumnNumber

getCorrectionDate

getCredit

getDayOfWeek

getFeaturePage

getGeneralOnlineDescriptors

getLocations

getNames

getNewsDesk

getNormalizedByline

getOnlineDescriptors

getOnlineLocations

getOnlineOrganizations

getOnlinePeople

getOnlineSection

getOnlineTitles

getOrganizations

getPage

getPeople

getPublicationDate

getPublicationDayOfMonth

getPublicationMonth

getPublicationYear

getSection

getSeriesName

getSlug

getSourcePath

getTaxonomicClassifiers

getTitles

getTypesOfMaterial

getUrl

getWordCount

toString