public class StartDocument extends BaseNameable implements IMultilingual
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
encoding |
protected java.lang.String |
filterId |
protected IFilterWriter |
filterWriter |
protected boolean |
hasUTF8BOM |
protected boolean |
isMultilingual |
protected java.lang.String |
lineBreak |
protected LocaleId |
locale |
protected IParameters |
params |
id, isTranslatable, mimeType, name, preserveWS, type
COPY_ALL, COPY_CONTENT, COPY_PROPERTIES, COPY_SEGMENTATION, COPY_SEGMENTED_CONTENT, CREATE_EMPTY
Constructor and Description |
---|
StartDocument() |
StartDocument(java.lang.String id) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getEncoding()
Gets the character set encoding of this document.
|
java.lang.String |
getFilterId()
Gets the current filter id for this document.
|
IParameters |
getFilterParameters()
Gets the current filter parameters for this document.
|
IFilterWriter |
getFilterWriter()
Gets the filter writer for this document.
|
java.lang.String |
getLineBreak()
Gets the type of line-break used in the original document.
|
LocaleId |
getLocale()
Gets the locale of this document.
|
java.util.Map<java.lang.String,Property> |
getSourceProperties() |
boolean |
hasUTF8BOM()
Indicates if this document is encoded as UTF8 and has a Byte-Order-Mark.
|
protected boolean |
isHasUTF8BOM() |
boolean |
isMultilingual()
Indicates if this document is multilingual.
|
protected void |
setEncoding(java.lang.String encoding) |
void |
setEncoding(java.lang.String encoding,
boolean hasUTF8BOM)
Sets the character set encoding of this document.
|
void |
setFilterId(java.lang.String filterId)
Sets the filter id for this document.
|
void |
setFilterParameters(IParameters params)
Sets the filter parameters for this document.
|
void |
setFilterWriter(IFilterWriter filterWriter)
Sets the filter writer for this document.
|
void |
setLineBreak(java.lang.String value)
Sets the type of line-break used in the original document.
|
void |
setLocale(LocaleId locale)
Sets the locale of the document.
|
void |
setMultilingual(boolean value)
Sets the flag that indicates if this document is multilingual.
|
getAnnotation, getAnnotations, getId, getMimeType, getName, getProperties, getProperty, getPropertyNames, getSkeleton, getType, hasProperty, isTranslatable, preserveWhitespaces, removeProperty, setAnnotation, setId, setIsTranslatable, setMimeType, setName, setPreserveWhitespaces, setProperty, setSkeleton, setType, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getMimeType, getName, getType, isTranslatable, preserveWhitespaces, setIsTranslatable, setMimeType, setName, setPreserveWhitespaces, setType
copy, getProperties, getProperty, getPropertyNames, hasProperty, propertyIterator, removeProperty, setProperty
annotationIterator, clear, copy, getAnnotation, getAnnotations, getAnnotationsTypesAsSet, hasAnnotation, hasAnnotations, remove, setAnnotation
getSkeleton, setSkeleton
copy, getSourceProperty, getSourcePropertyNames, hasSourceProperty, removeSourceProperty, setSourceProperty
copy, createTargetProperty, createTargetProperty, getAnnotations, getTargetLocales, getTargetProperties, getTargetProperty, getTargetPropertyNames, hasTargetProperty, removeTargetProperty, setTargetProperty
protected LocaleId locale
protected java.lang.String encoding
protected boolean isMultilingual
protected java.lang.String filterId
protected IParameters params
protected IFilterWriter filterWriter
protected boolean hasUTF8BOM
protected java.lang.String lineBreak
public StartDocument()
public StartDocument(java.lang.String id)
public LocaleId getLocale()
public void setLocale(LocaleId locale)
locale
- (source) locale of the document.public java.lang.String getEncoding()
public void setEncoding(java.lang.String encoding, boolean hasUTF8BOM)
encoding
- The string identifying the character set encoding of this document.
For example "UTF-8".hasUTF8BOM
- true if this document is UTf-8 and has a Byte-Order-Mark.
False in all other cases.public boolean isMultilingual()
public void setMultilingual(boolean value)
value
- true to set this document as multilingual, false to set it
as monolingual.public boolean hasUTF8BOM()
public java.lang.String getLineBreak()
public void setLineBreak(java.lang.String value)
value
- the type of line-break of the original document, for
example: "\r\n" (for Windows/DOS line-break).public IFilterWriter getFilterWriter()
public void setFilterWriter(IFilterWriter filterWriter)
filterWriter
- the filter writer for this document.public java.lang.String getFilterId()
public void setFilterId(java.lang.String filterId)
filterId
- the object containing the filter id for this document.public IParameters getFilterParameters()
public void setFilterParameters(IParameters params)
params
- the object containing the parameters for this document.protected boolean isHasUTF8BOM()
protected void setEncoding(java.lang.String encoding)
public java.util.Map<java.lang.String,Property> getSourceProperties()
getSourceProperties
in interface IWithSourceProperties
Map
of source properties for the implementer of interfaceCopyright © 2022. All rights reserved.