de.tuebingen.uni.sfs.dspin.tcf.profile
Class TextCorpusProfile

java.lang.Object
  de.tuebingen.uni.sfs.dspin.tcf.profile.TextCorpusProfile

All Implemented Interfaces:

de.tuebingen.uni.sfs.dspin.tcf.descriptor.api.IODescriptor

public class TextCorpusProfile
extends java.lang.Object
implements de.tuebingen.uni.sfs.dspin.tcf.descriptor.api.IODescriptor

Field Summary

static java.lang.String	languageAttrName
static java.lang.String	TextCorpusTag

Constructor Summary

TextCorpusProfile(javax.xml.stream.XMLEventReader xmlEventReader)
Constructs TextCorpusProfile by xmlEventReader reading the TextCorpus element contents of TCF 0.3 xml data.

Method Summary

java.lang.String	getLang() Get language of the TextCorpus data
de.tuebingen.uni.sfs.dspin.tcf.descriptor.api.LayerDescriptor	getLayerDescriptor(java.lang.String layerName) Get TextCorpus annotation layer description with the given name
java.util.List<de.tuebingen.uni.sfs.dspin.tcf.descriptor.api.LayerDescriptor>	getLayerDescriptors() Get list of TextCorpus annotation layers descriptions, i.e. for all TextCorpus annotation layers, such as text, tokens, sentences, lemmas, so on, present in the data, their names and attributes are encapsulated as IODescriptorTcfxb objects inside the list.
java.lang.String	getType()
java.lang.String	getVersion()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TextCorpusTag

public static final java.lang.String TextCorpusTag

See Also:

Constant Field Values

languageAttrName

public static final java.lang.String languageAttrName

See Also:

Constant Field Values

Constructor Detail

TextCorpusProfile

public TextCorpusProfile(javax.xml.stream.XMLEventReader xmlEventReader)
                  throws TextCorpusFormatException

Constructs TextCorpusProfile by xmlEventReader reading the TextCorpus element contents of TCF 0.3 xml data. After the TextCorpusProfile is constructed the read pointer of xmlEventReader will be put just after TextCorpus end element tag.

Parameters:

xmlEventReader - XMLEventReader that should contain TCF version 0.3 data stream and should have its current read pointer before TextCorpus element tag

Throws:

TextCorpusFormatException

Method Detail

getLang

public java.lang.String getLang()

Get language of the TextCorpus data

Specified by:

getLang in interface de.tuebingen.uni.sfs.dspin.tcf.descriptor.api.IODescriptor

Returns:

language of the TextCorpus data

getLayerDescriptors

public java.util.List<de.tuebingen.uni.sfs.dspin.tcf.descriptor.api.LayerDescriptor> getLayerDescriptors()

Get list of TextCorpus annotation layers descriptions, i.e. for all TextCorpus annotation layers, such as text, tokens, sentences, lemmas, so on, present in the data, their names and attributes are encapsulated as IODescriptorTcfxb objects inside the list.

Specified by:

getLayerDescriptors in interface de.tuebingen.uni.sfs.dspin.tcf.descriptor.api.IODescriptor

Returns:

list of TextCorpus annotation layers descriptions, each description contains layer name and layer attributes

getLayerDescriptor

public de.tuebingen.uni.sfs.dspin.tcf.descriptor.api.LayerDescriptor getLayerDescriptor(java.lang.String layerName)

Get TextCorpus annotation layer description with the given name

Specified by:

getLayerDescriptor in interface de.tuebingen.uni.sfs.dspin.tcf.descriptor.api.IODescriptor

Returns:

TextCorpus annotation layer description with the given name, or null if there is no such layer in the data

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getType

public java.lang.String getType()

Specified by:

getType in interface de.tuebingen.uni.sfs.dspin.tcf.descriptor.api.IODescriptor

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface de.tuebingen.uni.sfs.dspin.tcf.descriptor.api.IODescriptor