de.tudarmstadt.ukp.dkpro.core.api.metadata.type

Class DocumentMetaData

java.lang.Object

org.apache.uima.cas.impl.FeatureStructureImpl

org.apache.uima.jcas.cas.TOP

org.apache.uima.jcas.cas.AnnotationBase

org.apache.uima.jcas.tcas.Annotation

org.apache.uima.jcas.tcas.DocumentAnnotation

de.tudarmstadt.ukp.dkpro.core.api.metadata.type.DocumentMetaData

All Implemented Interfaces:

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

public class DocumentMetaData
extends org.apache.uima.jcas.tcas.DocumentAnnotation

Updated by JCasGen Sun Nov 21 13:28:48 CET 2010 XML source: /Users/bluefire/UKP/Workspaces/dkpro-primary/de.tudarmstadt.ukp.dkpro.core-asl/de.tudarmstadt.ukp.dkpro.core.api.metadata/src/main/resources/desc/type/DocumentMetaData.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	DocumentMetaData() Never called.
	DocumentMetaData(int addr, org.apache.uima.jcas.cas.TOP_Type type) Internal - constructor used by generator
	DocumentMetaData(org.apache.uima.jcas.JCas jcas)
	DocumentMetaData(org.apache.uima.jcas.JCas jcas, int begin, int end)

Method Summary

Modifier and Type	Method and Description
static void	copy(org.apache.uima.jcas.JCas aSourceView, org.apache.uima.jcas.JCas aTargetView) Copy the DocumentMetaData annotation from one view to another.
static DocumentMetaData	create(org.apache.uima.cas.CAS aCas) Create a new DocumentMetaData annotation in the given CAS.
static DocumentMetaData	create(org.apache.uima.jcas.JCas aJcas) Create a new DocumentMetaData annotation in the given CAS.
static DocumentMetaData	get(org.apache.uima.cas.CAS aCas) Get the DocumentMetaData from the CAS.
static DocumentMetaData	get(org.apache.uima.jcas.JCas aJCas) Get the DocumentMetaData from the CAS.
String	getCollectionId() getter for collectionId - gets The ID of the whole document collection.
String	getDocumentBaseUri() getter for documentBaseUri - gets Base URI of the document.
String	getDocumentId() getter for documentId - gets The id of the document.
String	getDocumentTitle() getter for documentTitle - gets The human readable title of the document.
String	getDocumentUri() getter for documentUri - gets The URI of the document.
boolean	getIsLastSegment() getter for isLastSegment - gets CAS de-multipliers need to know whether a CAS is the last multiplied segment.
int	getTypeIndexID()
void	setCollectionId(String v) setter for collectionId - sets The ID of the whole document collection.
void	setDocumentBaseUri(String v) setter for documentBaseUri - sets Base URI of the document.
void	setDocumentId(String v) setter for documentId - sets The id of the document.
void	setDocumentTitle(String v) setter for documentTitle - sets The human readable title of the document.
void	setDocumentUri(String v) setter for documentUri - sets The URI of the document.
void	setIsLastSegment(boolean v) setter for isLastSegment - sets CAS de-multipliers need to know whether a CAS is the last multiplied segment.

Methods inherited from class org.apache.uima.jcas.tcas.DocumentAnnotation

getLanguage, setLanguage

Methods inherited from class org.apache.uima.jcas.tcas.Annotation

getBegin, getCoveredText, getEnd, getStart, setBegin, setEnd

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.AnnotationBaseFS

getView

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

DocumentMetaData

protected DocumentMetaData()

Never called. Disable default constructor

DocumentMetaData

public DocumentMetaData(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

DocumentMetaData

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

Parameters:

jcas - JCas to which this Feature Structure belongs

DocumentMetaData

public DocumentMetaData(org.apache.uima.jcas.JCas jcas,
                        int begin,
                        int end)

Parameters:

jcas - JCas to which this Feature Structure belongs

begin - offset to the begin spot in the SofA

end - offset to the end spot in the SofA

Method Detail

getTypeIndexID

public int getTypeIndexID()

Overrides:

getTypeIndexID in class org.apache.uima.jcas.tcas.DocumentAnnotation

getDocumentTitle

public String getDocumentTitle()

getter for documentTitle - gets The human readable title of the document.

Returns:

value of the feature

setDocumentTitle

public void setDocumentTitle(String v)

setter for documentTitle - sets The human readable title of the document.

Parameters:

v - value to set into the feature

getDocumentId

public String getDocumentId()

getter for documentId - gets The id of the document.

Returns:

value of the feature

setDocumentId

public void setDocumentId(String v)

setter for documentId - sets The id of the document.

Parameters:

v - value to set into the feature

getDocumentUri

public String getDocumentUri()

getter for documentUri - gets The URI of the document.

Returns:

value of the feature

setDocumentUri

public void setDocumentUri(String v)

setter for documentUri - sets The URI of the document.

Parameters:

v - value to set into the feature

getCollectionId

public String getCollectionId()

getter for collectionId - gets The ID of the whole document collection.

Returns:

value of the feature

setCollectionId

public void setCollectionId(String v)

setter for collectionId - sets The ID of the whole document collection.

Parameters:

v - value to set into the feature

getDocumentBaseUri

public String getDocumentBaseUri()

getter for documentBaseUri - gets Base URI of the document.

Returns:

value of the feature

setDocumentBaseUri

public void setDocumentBaseUri(String v)

setter for documentBaseUri - sets Base URI of the document.

Parameters:

v - value to set into the feature

getIsLastSegment

public boolean getIsLastSegment()

getter for isLastSegment - gets CAS de-multipliers need to know whether a CAS is the last multiplied segment. Thus CAS multipliers should set this field to true for the last CAS they produce.

Returns:

value of the feature

setIsLastSegment

public void setIsLastSegment(boolean v)

setter for isLastSegment - sets CAS de-multipliers need to know whether a CAS is the last multiplied segment. Thus CAS multipliers should set this field to true for the last CAS they produce.

Parameters:

v - value to set into the feature

create

public static DocumentMetaData create(org.apache.uima.cas.CAS aCas)
                               throws IllegalStateException,
                                      org.apache.uima.cas.CASException

Create a new DocumentMetaData annotation in the given CAS. The meta data fields can then be set on the returned object.

Parameters:

aCas - the CAS to create the meta data for.

Returns:

a DocumentMetaData annotation that has already been added to the CAS indexes.

Throws:

IllegalStateException - if there is already a DocumentMetaData annotation

org.apache.uima.cas.CASException - if the JCas cannot be accessed from the provided CAS.

create

public static DocumentMetaData create(org.apache.uima.jcas.JCas aJcas)
                               throws IllegalStateException

Create a new DocumentMetaData annotation in the given CAS. The meta data fields can then be set on the returned object.

Parameters:

aJcas - the CAS to create the meta data for.

Returns:

a DocumentMetaData annotation that has already been added to the CAS indexes.

Throws:

IllegalStateException - if there is already a DocumentMetaData annotation

copy

public static void copy(org.apache.uima.jcas.JCas aSourceView,
                        org.apache.uima.jcas.JCas aTargetView)

Copy the DocumentMetaData annotation from one view to another.

Parameters:

aSourceView - the source.

aTargetView - the target.

get

public static DocumentMetaData get(org.apache.uima.cas.CAS aCas)

Get the DocumentMetaData from the CAS.

Parameters:

aCas - a CAS.

Returns:

the DocumentMetaData from the CAS.

Throws:

IllegalArgumentException - if no DocumentMetaData exists in the CAS.

get

public static DocumentMetaData get(org.apache.uima.jcas.JCas aJCas)

Get the DocumentMetaData from the CAS.

Parameters:

aJCas - the JCas.

Returns:

the DocumentMetaData from the CAS.

Throws:

IllegalArgumentException - if no DocumentMetaData exists in the CAS.