org.dkpro.core.io.nyt.metadata

Class NYTArticleMetaData

java.lang.Object

org.apache.uima.cas.impl.FeatureStructureImpl

org.apache.uima.jcas.cas.TOP

org.apache.uima.jcas.cas.AnnotationBase

org.dkpro.core.io.nyt.metadata.NYTArticleMetaData

All Implemented Interfaces:

Cloneable, org.apache.uima.cas.AnnotationBaseFS, org.apache.uima.cas.FeatureStructure

public class NYTArticleMetaData
extends org.apache.uima.jcas.cas.AnnotationBase

A document annotation that describes the metadata of a newspaper article. Updated by JCasGen Wed Jan 03 03:06:27 CET 2018 XML source: /Users/bluefire/git/dkpro-core/target/checkout/dkpro-core-io-nyt-asl/target/jcasgen/typesystem.xml

Field Summary

Fields

Modifier and Type	Field and Description
static int	type
static int	typeIndexID

Fields inherited from class org.apache.uima.jcas.cas.TOP

addr, jcasType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NYTArticleMetaData() Never called.
	NYTArticleMetaData(int addr, org.apache.uima.jcas.cas.TOP_Type type) Internal - constructor used by generator
	NYTArticleMetaData(org.apache.uima.jcas.JCas jcas)

Method Summary

Modifier and Type	Method and Description
String	getAlternateUrl() getter for alternateUrl - gets This field specifies the location on nytimes.com of the article.
String	getAuthor() getter for author - gets This field is based on the normalized byline in the original corpus data: "The Normalized Byline field is the byline normalized to the form (last name, first name)".
String	getColumnName() getter for columnName - gets If the article is part of a regular column, this field specifies the name of that column.
org.apache.uima.jcas.cas.StringArray	getDescriptors() getter for descriptors - gets The 'descriptors' field specifies a list of descriptive terms drawn from a normalized controlled vocabulary corresponding to subjects mentioned in the article.
String	getDescriptors(int i) indexed getter for descriptors - gets an indexed value - The 'descriptors' field specifies a list of descriptive terms drawn from a normalized controlled vocabulary corresponding to subjects mentioned in the article.
String	getGeneralOnlineDescriptors() getter for generalOnlineDescriptors - gets The 'general online descriptors' field specifies a list of descriptors that are at a higher level of generality than the other tags associated with the article.
int	getGuid() getter for Guid - gets The GUID field specifies a (4-byte) integer that is guaranteed to be unique for every document in the corpus.
String	getHeadline() getter for headline - gets This field specifies the headline of the article as it appeared in the print edition of the New York Times.
org.apache.uima.jcas.cas.StringArray	getOnlineDescriptors() getter for onlineDescriptors - gets This field specifies a list of descriptors from a normalized controlled vocabulary that correspond to topics mentioned in the article.
String	getOnlineDescriptors(int i) indexed getter for onlineDescriptors - gets an indexed value - This field specifies a list of descriptors from a normalized controlled vocabulary that correspond to topics mentioned in the article.
String	getOnlineHeadline() getter for onlineHeadline - gets This field specifies the headline displayed with the article on nytimes.com.
String	getOnlineSection() getter for onlineSection - gets This field specifies the section(s) on nytimes.com in which the article is placed.
String	getPublicationDate() getter for publicationDate - gets This field specifies the date of the article's publication.
String	getSection() getter for section - gets This field specifies the section of the paper in which the article appears.
org.apache.uima.jcas.cas.StringArray	getTaxonomicClassifiers() getter for taxonomicClassifiers - gets This field specifies a list of taxonomic classifiers that place this article into a hierarchy of articles.
String	getTaxonomicClassifiers(int i) indexed getter for taxonomicClassifiers - gets an indexed value - This field specifies a list of taxonomic classifiers that place this article into a hierarchy of articles.
int	getTypeIndexID()
org.apache.uima.jcas.cas.StringArray	getTypesOfMaterial() getter for typesOfMaterial - gets This field specifies a normalized list of terms describing the general editorial category of the article.
String	getTypesOfMaterial(int i) indexed getter for typesOfMaterial - gets an indexed value - This field specifies a normalized list of terms describing the general editorial category of the article.
String	getUrl() getter for url - gets This field specifies the location on nytimes.com of the article.
void	setAlternateUrl(String v) setter for alternateUrl - sets This field specifies the location on nytimes.com of the article.
void	setAuthor(String v) setter for author - sets This field is based on the normalized byline in the original corpus data: "The Normalized Byline field is the byline normalized to the form (last name, first name)".
void	setColumnName(String v) setter for columnName - sets If the article is part of a regular column, this field specifies the name of that column.
void	setDescriptors(int i, String v) indexed setter for descriptors - sets an indexed value - The 'descriptors' field specifies a list of descriptive terms drawn from a normalized controlled vocabulary corresponding to subjects mentioned in the article.
void	setDescriptors(org.apache.uima.jcas.cas.StringArray v) setter for descriptors - sets The 'descriptors' field specifies a list of descriptive terms drawn from a normalized controlled vocabulary corresponding to subjects mentioned in the article.
void	setGeneralOnlineDescriptors(String v) setter for generalOnlineDescriptors - sets The 'general online descriptors' field specifies a list of descriptors that are at a higher level of generality than the other tags associated with the article.
void	setGuid(int v) setter for Guid - sets The GUID field specifies a (4-byte) integer that is guaranteed to be unique for every document in the corpus.
void	setHeadline(String v) setter for headline - sets This field specifies the headline of the article as it appeared in the print edition of the New York Times.
void	setOnlineDescriptors(int i, String v) indexed setter for onlineDescriptors - sets an indexed value - This field specifies a list of descriptors from a normalized controlled vocabulary that correspond to topics mentioned in the article.
void	setOnlineDescriptors(org.apache.uima.jcas.cas.StringArray v) setter for onlineDescriptors - sets This field specifies a list of descriptors from a normalized controlled vocabulary that correspond to topics mentioned in the article.
void	setOnlineHeadline(String v) setter for onlineHeadline - sets This field specifies the headline displayed with the article on nytimes.com.
void	setOnlineSection(String v) setter for onlineSection - sets This field specifies the section(s) on nytimes.com in which the article is placed.
void	setPublicationDate(String v) setter for publicationDate - sets This field specifies the date of the article's publication.
void	setSection(String v) setter for section - sets This field specifies the section of the paper in which the article appears.
void	setTaxonomicClassifiers(int i, String v) indexed setter for taxonomicClassifiers - sets an indexed value - This field specifies a list of taxonomic classifiers that place this article into a hierarchy of articles.
void	setTaxonomicClassifiers(org.apache.uima.jcas.cas.StringArray v) setter for taxonomicClassifiers - sets This field specifies a list of taxonomic classifiers that place this article into a hierarchy of articles.
void	setTypesOfMaterial(int i, String v) indexed setter for typesOfMaterial - sets an indexed value - This field specifies a normalized list of terms describing the general editorial category of the article.
void	setTypesOfMaterial(org.apache.uima.jcas.cas.StringArray v) setter for typesOfMaterial - sets This field specifies a normalized list of terms describing the general editorial category of the article.
void	setUrl(String v) setter for url - sets This field specifies the location on nytimes.com of the article.

Methods inherited from class org.apache.uima.jcas.cas.AnnotationBase

getSofa, getView

Methods inherited from class org.apache.uima.jcas.cas.TOP

addToIndexes, addToIndexes, equals, getAddress, getCAS, getCASImpl, getLowLevelCas, hashCode, removeFromIndexes, removeFromIndexes

Methods inherited from class org.apache.uima.cas.impl.FeatureStructureImpl

clone, getavoidcollisionTypeCode, getBooleanValue, getByteValue, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getShortValue, getStringValue, getType, prettyPrint, prettyPrint, prettyPrint, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.uima.cas.FeatureStructure

clone, equals, getBooleanValue, getByteValue, getCAS, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getShortValue, getStringValue, getType, hashCode, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue

Field Detail

typeIndexID

public static final int typeIndexID

type

public static final int type

Constructor Detail

NYTArticleMetaData

protected NYTArticleMetaData()

Never called. Disable default constructor

NYTArticleMetaData

public NYTArticleMetaData(int addr,
                          org.apache.uima.jcas.cas.TOP_Type type)

Internal - constructor used by generator

Parameters:

addr - low level Feature Structure reference

type - the type of this Feature Structure

NYTArticleMetaData

public NYTArticleMetaData(org.apache.uima.jcas.JCas jcas)

Parameters:

jcas - JCas to which this Feature Structure belongs

Method Detail

getTypeIndexID

public int getTypeIndexID()

Overrides:

getTypeIndexID in class org.apache.uima.jcas.cas.AnnotationBase

Returns:

index of the type

getGuid

public int getGuid()

getter for Guid - gets The GUID field specifies a (4-byte) integer that is guaranteed to be unique for every document in the corpus.

Returns:

value of the feature

setGuid

public void setGuid(int v)

setter for Guid - sets The GUID field specifies a (4-byte) integer that is guaranteed to be unique for every document in the corpus.

Parameters:

v - value to set into the feature

getAlternateUrl

public String getAlternateUrl()

getter for alternateUrl - gets This field specifies the location on nytimes.com of the article. When present, this URL is preferred to the URL field on articles published on or after April 02, 2006, as the linked page will have richer content.

Returns:

value of the feature

setAlternateUrl

public void setAlternateUrl(String v)

setter for alternateUrl - sets This field specifies the location on nytimes.com of the article. When present, this URL is preferred to the URL field on articles published on or after April 02, 2006, as the linked page will have richer content.

Parameters:

v - value to set into the feature

getUrl

public String getUrl()

getter for url - gets This field specifies the location on nytimes.com of the article. The 'Alternative Url' field is preferred to this field on articles published on or after April 02, 2006, as the linked page will have richer content.

Returns:

value of the feature

setUrl

public void setUrl(String v)

setter for url - sets This field specifies the location on nytimes.com of the article. The 'Alternative Url' field is preferred to this field on articles published on or after April 02, 2006, as the linked page will have richer content.

Parameters:

v - value to set into the feature

getPublicationDate

public String getPublicationDate()

getter for publicationDate - gets This field specifies the date of the article's publication. This field is specified in the format YYYYMMDD'T'HHMMSS where: 1. YYYY is the four-digit year. 2. MM is the two-digit month [01-12]. 3. DD is the two-digit day [01-31]. 4. T is a constant value. 5. HH is the two-digit hour [00-23]. 6. MM is the two-digit minute-past-the hour [00-59] 7. SS is the two-digit seconds-past-the-minute [00-59]. Please note that values for HH,MM, and SS are not defined for this corpus, that is to day HH,MM, and SS are always defined to be '00'.

Returns:

value of the feature

setPublicationDate

public void setPublicationDate(String v)

setter for publicationDate - sets This field specifies the date of the article's publication. This field is specified in the format YYYYMMDD'T'HHMMSS where: 1. YYYY is the four-digit year. 2. MM is the two-digit month [01-12]. 3. DD is the two-digit day [01-31]. 4. T is a constant value. 5. HH is the two-digit hour [00-23]. 6. MM is the two-digit minute-past-the hour [00-59] 7. SS is the two-digit seconds-past-the-minute [00-59]. Please note that values for HH,MM, and SS are not defined for this corpus, that is to day HH,MM, and SS are always defined to be '00'.

Parameters:

v - value to set into the feature

getTypesOfMaterial

public org.apache.uima.jcas.cas.StringArray getTypesOfMaterial()

getter for typesOfMaterial - gets This field specifies a normalized list of terms describing the general editorial category of the article. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: REVIEW OBITUARY ANALYSIS

Returns:

value of the feature

setTypesOfMaterial

public void setTypesOfMaterial(org.apache.uima.jcas.cas.StringArray v)

setter for typesOfMaterial - sets This field specifies a normalized list of terms describing the general editorial category of the article. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: REVIEW OBITUARY ANALYSIS

Parameters:

v - value to set into the feature

getTypesOfMaterial

public String getTypesOfMaterial(int i)

indexed getter for typesOfMaterial - gets an indexed value - This field specifies a normalized list of terms describing the general editorial category of the article. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: REVIEW OBITUARY ANALYSIS

Parameters:

i - index in the array to get

Returns:

value of the element at index i

setTypesOfMaterial

public void setTypesOfMaterial(int i,
                               String v)

indexed setter for typesOfMaterial - sets an indexed value - This field specifies a normalized list of terms describing the general editorial category of the article. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: REVIEW OBITUARY ANALYSIS

Parameters:

i - index in the array to set

v - value to set into the array

getHeadline

public String getHeadline()

getter for headline - gets This field specifies the headline of the article as it appeared in the print edition of the New York Times.

Returns:

value of the feature

setHeadline

public void setHeadline(String v)

setter for headline - sets This field specifies the headline of the article as it appeared in the print edition of the New York Times.

Parameters:

v - value to set into the feature

getOnlineHeadline

public String getOnlineHeadline()

getter for onlineHeadline - gets This field specifies the headline displayed with the article on nytimes.com. Often this differs from the headline used in print.

Returns:

value of the feature

setOnlineHeadline

public void setOnlineHeadline(String v)

setter for onlineHeadline - sets This field specifies the headline displayed with the article on nytimes.com. Often this differs from the headline used in print.

Parameters:

v - value to set into the feature

getColumnName

public String getColumnName()

getter for columnName - gets If the article is part of a regular column, this field specifies the name of that column. Sample Column Names: 1. World News Briefs 2. WEDDINGS 3. The Accessories Channel

Returns:

value of the feature

setColumnName

public void setColumnName(String v)

setter for columnName - sets If the article is part of a regular column, this field specifies the name of that column. Sample Column Names: 1. World News Briefs 2. WEDDINGS 3. The Accessories Channel

Parameters:

v - value to set into the feature

getAuthor

public String getAuthor()

getter for author - gets This field is based on the normalized byline in the original corpus data: "The Normalized Byline field is the byline normalized to the form (last name, first name)".

Returns:

value of the feature

setAuthor

public void setAuthor(String v)

setter for author - sets This field is based on the normalized byline in the original corpus data: "The Normalized Byline field is the byline normalized to the form (last name, first name)".

Parameters:

v - value to set into the feature

getDescriptors

public org.apache.uima.jcas.cas.StringArray getDescriptors()

getter for descriptors - gets The 'descriptors' field specifies a list of descriptive terms drawn from a normalized controlled vocabulary corresponding to subjects mentioned in the article. These tags are hand-assigned by a team of library scientists working in the New York Times Indexing service. Examples Include: ECONOMIC CONDITIONS AND TRENDS AIRPLANES VIOLINS

Returns:

value of the feature

setDescriptors

public void setDescriptors(org.apache.uima.jcas.cas.StringArray v)

setter for descriptors - sets The 'descriptors' field specifies a list of descriptive terms drawn from a normalized controlled vocabulary corresponding to subjects mentioned in the article. These tags are hand-assigned by a team of library scientists working in the New York Times Indexing service. Examples Include: ECONOMIC CONDITIONS AND TRENDS AIRPLANES VIOLINS

Parameters:

v - value to set into the feature

getDescriptors

public String getDescriptors(int i)

indexed getter for descriptors - gets an indexed value - The 'descriptors' field specifies a list of descriptive terms drawn from a normalized controlled vocabulary corresponding to subjects mentioned in the article. These tags are hand-assigned by a team of library scientists working in the New York Times Indexing service. Examples Include: ECONOMIC CONDITIONS AND TRENDS AIRPLANES VIOLINS

Parameters:

i - index in the array to get

Returns:

value of the element at index i

setDescriptors

public void setDescriptors(int i,
                           String v)

indexed setter for descriptors - sets an indexed value - The 'descriptors' field specifies a list of descriptive terms drawn from a normalized controlled vocabulary corresponding to subjects mentioned in the article. These tags are hand-assigned by a team of library scientists working in the New York Times Indexing service. Examples Include: ECONOMIC CONDITIONS AND TRENDS AIRPLANES VIOLINS

Parameters:

i - index in the array to set

v - value to set into the array

getOnlineDescriptors

public org.apache.uima.jcas.cas.StringArray getOnlineDescriptors()

getter for onlineDescriptors - gets This field specifies a list of descriptors from a normalized controlled vocabulary that correspond to topics mentioned in the article. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: Marriages Parks and Other Recreation Areas Cooking and Cookbooks

Returns:

value of the feature

setOnlineDescriptors

public void setOnlineDescriptors(org.apache.uima.jcas.cas.StringArray v)

setter for onlineDescriptors - sets This field specifies a list of descriptors from a normalized controlled vocabulary that correspond to topics mentioned in the article. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: Marriages Parks and Other Recreation Areas Cooking and Cookbooks

Parameters:

v - value to set into the feature

getOnlineDescriptors

public String getOnlineDescriptors(int i)

indexed getter for onlineDescriptors - gets an indexed value - This field specifies a list of descriptors from a normalized controlled vocabulary that correspond to topics mentioned in the article. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: Marriages Parks and Other Recreation Areas Cooking and Cookbooks

Parameters:

i - index in the array to get

Returns:

value of the element at index i

setOnlineDescriptors

public void setOnlineDescriptors(int i,
                                 String v)

indexed setter for onlineDescriptors - sets an indexed value - This field specifies a list of descriptors from a normalized controlled vocabulary that correspond to topics mentioned in the article. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: Marriages Parks and Other Recreation Areas Cooking and Cookbooks

Parameters:

i - index in the array to set

v - value to set into the array

getGeneralOnlineDescriptors

public String getGeneralOnlineDescriptors()

getter for generalOnlineDescriptors - gets The 'general online descriptors' field specifies a list of descriptors that are at a higher level of generality than the other tags associated with the article. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: Surfing Venice Biennale Ranches

Returns:

value of the feature

setGeneralOnlineDescriptors

public void setGeneralOnlineDescriptors(String v)

setter for generalOnlineDescriptors - sets The 'general online descriptors' field specifies a list of descriptors that are at a higher level of generality than the other tags associated with the article. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: Surfing Venice Biennale Ranches

Parameters:

v - value to set into the feature

getOnlineSection

public String getOnlineSection()

getter for onlineSection - gets This field specifies the section(s) on nytimes.com in which the article is placed. If the article is placed in multiple sections, this field will be specified as a ';' delineated list.

Returns:

value of the feature

setOnlineSection

public void setOnlineSection(String v)

setter for onlineSection - sets This field specifies the section(s) on nytimes.com in which the article is placed. If the article is placed in multiple sections, this field will be specified as a ';' delineated list.

Parameters:

v - value to set into the feature

getSection

public String getSection()

getter for section - gets This field specifies the section of the paper in which the article appears. This is not the name of the section, but rather a letter or number that indicates the section.

Returns:

value of the feature

setSection

public void setSection(String v)

setter for section - sets This field specifies the section of the paper in which the article appears. This is not the name of the section, but rather a letter or number that indicates the section.

Parameters:

v - value to set into the feature

getTaxonomicClassifiers

public org.apache.uima.jcas.cas.StringArray getTaxonomicClassifiers()

getter for taxonomicClassifiers - gets This field specifies a list of taxonomic classifiers that place this article into a hierarchy of articles. The individual terms of each taxonomic classifier are separated with the '/' character. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: Top/Features/Travel/Guides/Destinations/North America/United States/Arizona Top/News/U.S./Rockies Top/Opinion

Returns:

value of the feature

setTaxonomicClassifiers

public void setTaxonomicClassifiers(org.apache.uima.jcas.cas.StringArray v)

setter for taxonomicClassifiers - sets This field specifies a list of taxonomic classifiers that place this article into a hierarchy of articles. The individual terms of each taxonomic classifier are separated with the '/' character. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: Top/Features/Travel/Guides/Destinations/North America/United States/Arizona Top/News/U.S./Rockies Top/Opinion

Parameters:

v - value to set into the feature

getTaxonomicClassifiers

public String getTaxonomicClassifiers(int i)

indexed getter for taxonomicClassifiers - gets an indexed value - This field specifies a list of taxonomic classifiers that place this article into a hierarchy of articles. The individual terms of each taxonomic classifier are separated with the '/' character. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: Top/Features/Travel/Guides/Destinations/North America/United States/Arizona Top/News/U.S./Rockies Top/Opinion

Parameters:

i - index in the array to get

Returns:

value of the element at index i

setTaxonomicClassifiers

public void setTaxonomicClassifiers(int i,
                                    String v)

indexed setter for taxonomicClassifiers - sets an indexed value - This field specifies a list of taxonomic classifiers that place this article into a hierarchy of articles. The individual terms of each taxonomic classifier are separated with the '/' character. These tags are algorithmically assigned and manually verified by nytimes.com production staff. Examples Include: Top/Features/Travel/Guides/Destinations/North America/United States/Arizona Top/News/U.S./Rockies Top/Opinion

Parameters:

i - index in the array to set

v - value to set into the array