net.sf.okapi.filters.openxml

Class StandardPartHandler

java.lang.Object

net.sf.okapi.filters.openxml.StandardPartHandler

All Implemented Interfaces:

Iterator<Event>, OpenXMLPartHandler

public class StandardPartHandler
extends Object

The default part handler for OpenXMLContentFilter-based processing.

Field Summary

Fields

Modifier and Type	Field and Description
protected OpenXMLContentFilter	contentFilter
protected List<XMLEvent>	documentPartEvents
protected IdGenerator	documentPartIdGenerator
protected ZipEntry	entry
protected List<Event>	filterEvents
protected ConditionalParameters	params
protected net.sf.okapi.filters.openxml.OpenXMLZipFile	zipFile

Constructor Summary

Constructors

Constructor and Description
StandardPartHandler(OpenXMLContentFilter contentFilter, ConditionalParameters cparams, net.sf.okapi.filters.openxml.OpenXMLZipFile zipFile, ZipEntry entry)

Method Summary

Modifier and Type	Method and Description
protected void	addEventToDocumentPart(XMLEvent e)
void	close()
protected Event	createStartSubDocumentEvent(String documentId, String subDocumentId)
boolean	hasNext()
void	logEvent(Event e)
Event	next()
Event	open(String documentId, String subDocumentId, LocaleId srcLang) Open this part and perform any initial processing.
protected Event	openContentFilter(InputStream is, String documentId, String subDocumentId, LocaleId srcLang) Open the nested OpenXMLContentFilter instance on the specified InputStream, and convert a START_SUBDOCUMENT event for it.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

contentFilter

protected OpenXMLContentFilter contentFilter

params

protected final ConditionalParameters params

zipFile

protected final net.sf.okapi.filters.openxml.OpenXMLZipFile zipFile

entry

protected final ZipEntry entry

filterEvents

protected final List<Event> filterEvents

documentPartIdGenerator

protected final IdGenerator documentPartIdGenerator

documentPartEvents

protected List<XMLEvent> documentPartEvents

Constructor Detail

StandardPartHandler

public StandardPartHandler(OpenXMLContentFilter contentFilter,
                           ConditionalParameters cparams,
                           net.sf.okapi.filters.openxml.OpenXMLZipFile zipFile,
                           ZipEntry entry)

Method Detail

open

public Event open(String documentId,
                  String subDocumentId,
                  LocaleId srcLang)
           throws IOException

Description copied from interface: OpenXMLPartHandler

Open this part and perform any initial processing. Return the first event for this part.

Parameters:

documentId - document identifier

subDocumentId - sub-document identifier

srcLang - the locale of the source

Returns:

first event for this part.

Throws:

IOException - if any problem is encountered

hasNext

public boolean hasNext()

next

public Event next()

close

public void close()

openContentFilter

protected Event openContentFilter(InputStream is,
                                  String documentId,
                                  String subDocumentId,
                                  LocaleId srcLang)

Open the nested OpenXMLContentFilter instance on the specified InputStream, and convert a START_SUBDOCUMENT event for it.

Parameters:

is - input stream

documentId - document identifier

subDocumentId - sub-document identifier

srcLang - the source language

Returns:

the START_SUBDOCUMENT Event

logEvent

public void logEvent(Event e)

createStartSubDocumentEvent

protected Event createStartSubDocumentEvent(String documentId,
                                            String subDocumentId)

addEventToDocumentPart

protected void addEventToDocumentPart(XMLEvent e)