|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.init.its.okapi.ext.ODFFilter
public class ODFFilter
This class implements IFilter for XML documents in Open-Document format (ODF). The expected input is the XML document itself. It can be used on ODF documents that are not in Open-Office.org files (i.e. directly on the content.xml of the .odt). For processing ODT, ODS, etc. documents, use the OpenOfficeFilter class, which calls this filter as needed.
Field Summary | |
---|---|
protected static java.lang.String |
NSURI_TEXT
|
protected static java.lang.String |
NSURI_XLINK
|
protected static java.lang.String |
OFFICE_ANNOTATION
|
protected static java.lang.String |
TEXT_BOOKMARK_REF
|
Fields inherited from interface de.init.its.okapi.ext.IFilter |
---|
SUB_FILTER |
Constructor Summary | |
---|---|
ODFFilter()
|
Method Summary | |
---|---|
void |
cancel()
Cancels the current process. |
void |
close()
Closes the input document. |
net.sf.okapi.common.filterwriter.IFilterWriter |
createFilterWriter()
Creates a new IFilterWriter object from the most appropriate class to use with this filter. |
net.sf.okapi.common.skeleton.ISkeletonWriter |
createSkeletonWriter()
Creates a new ISkeletonWriter object that corresponds to the type of skeleton this filter uses. |
java.util.List<net.sf.okapi.common.filters.FilterConfiguration> |
getConfigurations()
Gets the list of all predefined configurations for this filter. |
java.lang.String |
getDisplayName()
Gets the localizable display name of this filter. |
net.sf.okapi.common.encoder.EncoderManager |
getEncoderManager()
Gets the EncoderManager object for this filter. |
java.lang.String |
getMimeType()
Gets the MIME type of the format supported by this filter. |
java.lang.String |
getName()
Gets the name/identifier of this filter. |
net.sf.okapi.common.IParameters |
getParameters()
Gets the current parameters for this filter. |
boolean |
hasNext()
Indicates if there is an event to process. |
net.sf.okapi.common.Event |
next()
Gets the next event available. |
void |
open(net.sf.okapi.common.resource.RawDocument input)
Opens the input document described in a give RawDocument object. |
void |
open(net.sf.okapi.common.resource.RawDocument input,
boolean generateSkeleton)
Opens the input document described in a give RawDocument object, and optionally creates skeleton information. |
void |
setContainerMimeType(java.lang.String mimeType)
Sets the MIME type of the file containing this document. |
void |
setFilterConfigurationMapper(net.sf.okapi.common.filters.IFilterConfigurationMapper fcMapper)
Sets the filter configuration mapper for this filter. |
void |
setParameters(net.sf.okapi.common.IParameters newParams)
Sets new parameters for this filter. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final java.lang.String NSURI_TEXT
protected static final java.lang.String NSURI_XLINK
protected static final java.lang.String TEXT_BOOKMARK_REF
protected static final java.lang.String OFFICE_ANNOTATION
Constructor Detail |
---|
public ODFFilter()
Method Detail |
---|
public void close()
IFilter
close
in interface IFilter
public void cancel()
IFilter
cancel
in interface IFilter
public boolean hasNext()
IFilter
Implementer Note: The caller must be able to call this method several times without changing state.
hasNext
in interface IFilter
public void open(net.sf.okapi.common.resource.RawDocument input)
IFilter
open
in interface IFilter
input
- The RawDocument object to use to open the document.public void open(net.sf.okapi.common.resource.RawDocument input, boolean generateSkeleton)
IFilter
open
in interface IFilter
input
- The RawDocument object to use to open the document.public void setContainerMimeType(java.lang.String mimeType)
mimeType
- the MIME type to set.public java.lang.String getName()
IFilter
getName
in interface IFilter
public java.lang.String getDisplayName()
IFilter
getDisplayName
in interface IFilter
public java.lang.String getMimeType()
IFilter
getMimeType
in interface IFilter
public java.util.List<net.sf.okapi.common.filters.FilterConfiguration> getConfigurations()
IFilter
getConfigurations
in interface IFilter
public net.sf.okapi.common.encoder.EncoderManager getEncoderManager()
IFilter
getEncoderManager
in interface IFilter
public net.sf.okapi.common.IParameters getParameters()
IFilter
getParameters
in interface IFilter
public net.sf.okapi.common.Event next()
IFilter
next
in interface IFilter
public void setFilterConfigurationMapper(net.sf.okapi.common.filters.IFilterConfigurationMapper fcMapper)
IFilter
setFilterConfigurationMapper
in interface IFilter
fcMapper
- the mapper to set.public void setParameters(net.sf.okapi.common.IParameters newParams)
IFilter
setParameters
in interface IFilter
newParams
- The new parameters to use.public net.sf.okapi.common.skeleton.ISkeletonWriter createSkeletonWriter()
IFilter
createSkeletonWriter
in interface IFilter
public net.sf.okapi.common.filterwriter.IFilterWriter createFilterWriter()
IFilter
createFilterWriter
in interface IFilter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |