eu.clarin.weblicht.wlfxb.io

Class TextCorpusStreamedWithReplaceableLayers

java.lang.Object

eu.clarin.weblicht.wlfxb.tc.xb.TextCorpusStored

eu.clarin.weblicht.wlfxb.io.TextCorpusStreamedWithReplaceableLayers

All Implemented Interfaces:

TextCorpus, Closeable, AutoCloseable

public class TextCorpusStreamedWithReplaceableLayers
extends TextCorpusStored
implements Closeable

Class TextCorpusStreamedWithReplaceableLayers can be used for applications where an existing TCF layer has to be replaced or removed. New layers can also be added. A care should be taken by the user of this class, that there are no layers left in the TCF that depend on the layers being replaced. Do not use this class for the usual WebLicht services use case (WebLicht services are not allowed to change existing TCF layers). For the usual use case within WebLicht, use TextCorpusStreamed class.

Author:

Yana Panchenko

Field Summary

Fields inherited from class eu.clarin.weblicht.wlfxb.tc.xb.TextCorpusStored

lang, layersInOrder, XML_NAME, XML_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
TextCorpusStreamedWithReplaceableLayers(InputStream inputStream, EnumSet<TextCorpusLayerTag> layersToRead, EnumSet<TextCorpusLayerTag> layersToReplace, OutputStream outputStream) Creates a TextCorpusStreamedWithReplaceableLayers from the given TCF input stream,specified annotation layers and the output stream.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the input and output streams associated with this object and releases any associated system resources.

Methods inherited from class eu.clarin.weblicht.wlfxb.tc.xb.TextCorpusStored

afterUnmarshal, compose, connectLayers, createAntonymyLayer, createChunksLayer, createConstituentParsingLayer, createDependencyParsingLayer, createDependencyParsingLayer, createDiscourseConnectivesLayer, createDiscourseConnectivesLayer, createGeoLayer, createGeoLayer, createGeoLayer, createGeoLayer, createGeoLayer, createGeoLayer, createGeoLayer, createGeoLayer, createHyperonymyLayer, createHyponymyLayer, createLemmasLayer, createMatchesLayer, createMorphologyLayer, createMorphologyLayer, createMorphologyLayer, createMorphologyLayer, createMorphologyLayer, createMorphologyLayer, createNamedEntitiesLayer, createOrthographyLayer, createPhotenicsLayer, createPosTagsLayer, createReferencesLayer, createRelationsLayer, createSentencesLayer, createSentencesLayer, createSynonymyLayer, createTextLayer, createTextSourceLayer, createTextStructureLayer, createTokensLayer, createTokensLayer, createWordSensesLayer, createWordSplittingLayer, getAntonymyLayer, getChunksLayer, getConstituentParsingLayer, getDependencyParsingLayer, getDiscourseConnectivesLayer, getGeoLayer, getHyperonymyLayer, getHyponymyLayer, getLanguage, getLayers, getLemmasLayer, getMatchesLayer, getMorphologyLayer, getNamedEntitiesLayer, getOrthographyLayer, getPhoneticsLayer, getPosTagsLayer, getReferencesLayer, getRelationsLayer, getSentencesLayer, getSynonymyLayer, getTextLayer, getTextSourceLayer, getTextStructureLayer, getTokensLayer, getWordSensesLayer, getWordSplittingLayer, setAntonymyLayer, setChunksLayer, setConstituentParsingLayer, setDependencyParsingLayer, setDiscourseConnectivesLayer, setGeoLayer, setHyperonymyLayer, setHyponymyLayer, setLemmasLayer, setMatchesLayer, setMorphologyLayer, setNamedEntitiesLayer, setOrthographyLayer, setPhoneticsLayer, setPosTagsLayer, setReferencesLayer, setRelationsLayer, setSentencesLayer, setSynonymyLayer, setTextLayer, setTextSourceLayer, setTextStructureLayer, setTokensLayer, setWordSensesLayer, setWordSplittingLayer, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TextCorpusStreamedWithReplaceableLayers

public TextCorpusStreamedWithReplaceableLayers(InputStream inputStream,
                                               EnumSet<TextCorpusLayerTag> layersToRead,
                                               EnumSet<TextCorpusLayerTag> layersToReplace,
                                               OutputStream outputStream)
                                        throws WLFormatException

Creates a TextCorpusStreamedWithReplaceableLayers from the given TCF input stream,specified annotation layers and the output stream.

Parameters:

inputStream - the underlying input stream with linguistic annotations in TCF format.

layersToRead - the annotation layers of TextCorpus that should be read into this TextCorpusStreamedWithReplaceableLayers.

layersToReplace - the annotation layers of TextCorpus that should not be read into TextCorpusStreamedWithReplaceableLayers and should not be rewritten into the output stream.

outputStream - the underlying output stream into which the annotations from the input stream and any new created annotations will be written (in TCF format).

Throws:

WLFormatException - if an error in input format or an I/O error occurs.

Method Detail

close

public void close()
           throws WLFormatException

Closes the input and output streams associated with this object and releases any associated system resources. Before the streams are closed, all in-memory annotations of the TextCorpus and not-processed part of the input stream are written to the output stream. Therefore, it's important to call close() method, so that all the in-memory annotations are saved to the output stream. Once closed, adding further annotations will have no effect on the output stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

WLFormatException - if an error in input format or an I/O error occurs.