net.sf.okapi.common.filterwriter.ext
Class XLIFFWriterParameters

java.lang.Object
  extended by net.sf.okapi.common.BaseParameters
      extended by net.sf.okapi.common.filterwriter.ext.XLIFFWriterParameters
All Implemented Interfaces:
net.sf.okapi.common.IParameters

public class XLIFFWriterParameters
extends net.sf.okapi.common.BaseParameters

Provides a way to access the parameters for XLIFFWriter in a single object.


Field Summary
 
Fields inherited from class net.sf.okapi.common.BaseParameters
buffer, path
 
Constructor Summary
XLIFFWriterParameters()
           
 
Method Summary
 void fromString(java.lang.String data)
           
 boolean getCopySource()
           
 boolean getEscapeGt()
           
 boolean getIncludeAltTrans()
           
 boolean getIncludeCodeAttrs()
           
 boolean getIncludeIts()
          Gets the flag indicating if ITS markup should be output or not.
 boolean getIncludeNoTranslate()
           
 net.sf.okapi.common.ParametersDescription getParametersDescription()
           
 boolean getPlaceholderMode()
          Gets the flag indicating if the inline code should use the place-holder notation (g and x elements).
 boolean getSetApprovedAsNoTranslate()
           
 boolean getUseSourceForTranslated()
           
 void reset()
           
 void setCopySource(boolean copySource)
          Sets the copySource flag indicating to copy the source at the target spot if there is no target defined.
 void setEscapeGt(boolean escapeGt)
          Sets the flag indicating if '>' should be escaped or not.
 void setIncludeAltTrans(boolean includeAltTrans)
          Sets the flag indicating if alt-trans elements should be output or not.
 void setIncludeCodeAttrs(boolean includeCodeAttrs)
          Sets the flag indicating if extended code attributes should be output or not.
 void setIncludeIts(boolean includeIts)
          Sets the flag indicating if ITS markup should be output or not.
 void setIncludeNoTranslate(boolean includeNoTranslate)
          Sets the flag indicating if non-translatable text units should be output or not.
 void setPlaceholderMode(boolean placeholderMode)
          Sets the flag indicating if the inline code should use the place-holder notation (g and x elements).
 void setSetApprovedAsNoTranslate(boolean setApprovedAsNoTranslate)
          Sets the flag indicating to mark as not translatable all entries that are approved.
 void setUseSourceForTranslated(boolean useSourceForTranslated)
          Sets the flag indicating if the source text is used in the target, even if a target is available.
 java.lang.String toString()
           
 
Methods inherited from class net.sf.okapi.common.BaseParameters
getBoolean, getInteger, getPath, getString, load, save, setBoolean, setInteger, setPath, setString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XLIFFWriterParameters

public XLIFFWriterParameters()
Method Detail

getUseSourceForTranslated

public boolean getUseSourceForTranslated()

setUseSourceForTranslated

public void setUseSourceForTranslated(boolean useSourceForTranslated)
Sets the flag indicating if the source text is used in the target, even if a target is available.

This is for the tools where we trust the target will be obtained by the tool from the TMX from original. This is to allow editing of pre-translated items in XLIFF editors that use directly the element.

Parameters:
useSourceForTranslated - true to use the source in the target even if a target text is available.

getEscapeGt

public boolean getEscapeGt()

setEscapeGt

public void setEscapeGt(boolean escapeGt)
Sets the flag indicating if '>' should be escaped or not.

Parameters:
escapeGt - true to always escape '>', false to not escape it.

getPlaceholderMode

public boolean getPlaceholderMode()
Gets the flag indicating if the inline code should use the place-holder notation (g and x elements).

Returns:
true if the inline code should use the place-holder notation.

setPlaceholderMode

public void setPlaceholderMode(boolean placeholderMode)
Sets the flag indicating if the inline code should use the place-holder notation (g and x elements).

Parameters:
placeholderMode - true if the inline code should use the place-holder notation.

getIncludeNoTranslate

public boolean getIncludeNoTranslate()

setIncludeNoTranslate

public void setIncludeNoTranslate(boolean includeNoTranslate)
Sets the flag indicating if non-translatable text units should be output or not.

Parameters:
includeNoTranslate - true to include non-translatable text unit in the output.

getSetApprovedAsNoTranslate

public boolean getSetApprovedAsNoTranslate()

setSetApprovedAsNoTranslate

public void setSetApprovedAsNoTranslate(boolean setApprovedAsNoTranslate)
Sets the flag indicating to mark as not translatable all entries that are approved.

Parameters:
setApprovedAsNoTranslate - true to mark approved entries as not translatable.

getCopySource

public boolean getCopySource()

setCopySource

public void setCopySource(boolean copySource)
Sets the copySource flag indicating to copy the source at the target spot if there is no target defined.

Parameters:
copySource - true to copy the source at the target spot if there is no target defined.

getIncludeAltTrans

public boolean getIncludeAltTrans()

setIncludeAltTrans

public void setIncludeAltTrans(boolean includeAltTrans)
Sets the flag indicating if alt-trans elements should be output or not.

Parameters:
includeAltTrans - true to include alt-trans element in the output.

getIncludeCodeAttrs

public boolean getIncludeCodeAttrs()

setIncludeCodeAttrs

public void setIncludeCodeAttrs(boolean includeCodeAttrs)
Sets the flag indicating if extended code attributes should be output or not.

Parameters:
includeCodeAttrs - true to include extended code attributes in the output.

getIncludeIts

public boolean getIncludeIts()
Gets the flag indicating if ITS markup should be output or not.

Returns:
true if ITS markup should be output, false otherwise.

setIncludeIts

public void setIncludeIts(boolean includeIts)
Sets the flag indicating if ITS markup should be output or not.

Parameters:
includeIts - true to include ITS markup in the output.

reset

public void reset()

fromString

public void fromString(java.lang.String data)

toString

public java.lang.String toString()
Specified by:
toString in interface net.sf.okapi.common.IParameters
Overrides:
toString in class java.lang.Object

getParametersDescription

public net.sf.okapi.common.ParametersDescription getParametersDescription()
Specified by:
getParametersDescription in interface net.sf.okapi.common.IParameters
Overrides:
getParametersDescription in class net.sf.okapi.common.BaseParameters