src.com.ibm.as400.access.BidiConversionProperties Maven / Gradle / Ivy
Show all versions of jt400 Show documentation
///////////////////////////////////////////////////////////////////////////////
//
// JTOpen (IBM Toolbox for Java - OSS version)
//
// Filename: BidiConversionOptions.java
//
// The source code contained herein is licensed under the IBM Public License
// Version 1.0, which has been approved by the Open Source Initiative.
// Copyright (C) 2004-2005 International Business Machines Corporation and
// others. All rights reserved.
//
///////////////////////////////////////////////////////////////////////////////
package com.ibm.as400.access;
import java.io.Serializable;
/**
Provides a set of properties that can be used to control the conversion of character set data.
**/
public class BidiConversionProperties implements Serializable
{
static final long serialVersionUID = 4L;
// String type.
private int bidiStringType_ = BidiStringType.DEFAULT;
// Only remove marks on the J2A transform.
private boolean removeMarksOnImplicitToVisual_ = false;
// All of the options to affect BIDI transforms.
private boolean impToImp_ = true;
private boolean roundTrip_;
private boolean winCompatible_;
private boolean insertMarkers_;
private boolean removeMarkers_;
private int options_;
private boolean wordBreak_;
private boolean destinationRequired_ = true;
private boolean srcToDstMapRequired_;
private boolean dstToSrcMapRequired_;
private boolean propertyMapRequired_;
private boolean continuation_;
private int numeralShaping_ = NUMERALS_DEFAULT;
private int inpCount_;
private int outCount_;
private int[] srcToDstMap_;
private int[] dstToSrcMap_;
private byte[] propertyMap_;
private boolean expandLamAlef = false;//@bd1a_ramysaid
private transient int lastBidiStringType = -1;
private transient boolean oldBidiNumericOrderingRoundTrip = false;
private transient boolean oldBidiImplicitReordering = true ;
/**
* Value identifying that numeral shapes should be the default
* according to the string type.
*/
public static final int NUMERALS_DEFAULT = 0;
/**
* Value identifying that numeral shapes are Nominal.
* Use Arabic digit shapes (1,2,3) for all numbers.
*/
public static final int NUMERALS_NOMINAL = 1;
/**
* Value identifying that numeral shapes are National
* Use Indic digit shapes for all numbers.
*/
public static final int NUMERALS_NATIONAL = 2;
/**
* Value identifying that numeral shapes are Contextual (Nominal or National
* depending on context)
* Use nominal or national depending on context.
*/
public static final int NUMERALS_CONTEXTUAL = 3;
/**
* Value identifying that numeral shapes can be Nominal or National
* Pass-through the original digit shapes.
*/
public static final int NUMERALS_ANY = 4;
/**
Constructs a BidiConversionProperties object.
**/
public BidiConversionProperties()
{
if (Trace.traceConversion_) traceLog(Trace.DIAGNOSTIC, "Constructing BidiConversionProperties.");
}
BidiConversionProperties(int bidiStringType)
{
setBidiStringType(bidiStringType);
}
BidiConversionProperties(int bidiStringType, BidiTransform transform, boolean removeMarkersOnImplicitToVisual)
{
// String type.
setBidiStringType(bidiStringType);
// Copy options.
impToImp_ = transform.impToImp;
roundTrip_ = transform.roundTrip;
winCompatible_ = transform.winCompatible;
insertMarkers_ = transform.insertMarkers;
removeMarkers_ = transform.removeMarkers;
if (transform.options != null) options_ = transform.options.value;
wordBreak_ = transform.wordBreak;
destinationRequired_ = transform.destinationRequired;
srcToDstMapRequired_ = transform.srcToDstMapRequired;
dstToSrcMapRequired_ = transform.dstToSrcMapRequired;
propertyMapRequired_ = transform.propertyMapRequired;
continuation_ = transform.continuation;
// Set remove markers special case option.
removeMarksOnImplicitToVisual_ = removeMarkersOnImplicitToVisual;
// The remove markers should not be true in general, only in J2A case.
if (removeMarkersOnImplicitToVisual)
{
removeMarkers_ = false;
}
// Copy output results.
dstToSrcMap_ = transform.dstToSrcMap;
srcToDstMap_ = transform.srcToDstMap;
propertyMap_ = transform.propertyMap;
inpCount_ = transform.inpCount;
outCount_ = transform.outCount;
getNumeralShapingFromTransform(transform);
//@bd1a_start_ramysaid
if (transform.options != null) {
expandLamAlef = (transform.options.getLamAlefMode() == ArabicOption.LAMALEF_RESIZE_BUFFER);
} else {
expandLamAlef = false;
}
//@bd1a_end_ramysaid
}
/**
Sets the bidi string type, as defined by the CDRA (Character Data Representation Architecture). See BidiStringType for more information and valid values. This option is set to BidiStringType.DEFAULT by default.
@param bidiStringType The bidi string type.
**/
public void setBidiStringType(int bidiStringType)
{
if (Trace.traceConversion_) {
if (bidiStringType != lastBidiStringType) {
traceLog( Trace.DIAGNOSTIC, "Setting bidi string type:"+ bidiStringType);
lastBidiStringType = bidiStringType;
}
}
if (bidiStringType != BidiStringType.NONE && bidiStringType != BidiStringType.DEFAULT && (bidiStringType < BidiStringType.ST4 || bidiStringType > BidiStringType.ST11))
{
traceLog( Trace.ERROR, "Value of parameter 'bidiStringType' is not valid:"+ bidiStringType);
throw new ExtendedIllegalArgumentException("bidiStringType (" + bidiStringType + ")", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
bidiStringType_ = bidiStringType;
}
/**
Gets the bidi string type.
@return The bidi string type.
**/
public int getBidiStringType()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Getting bidi string type:"+ bidiStringType_);
return bidiStringType_;
}
/**
Remove the directional marks only when transforming from logical to visual.
@param removeMarks true to remove the directional marks only when transforming from logical to visual; false otherwise.
**/
public void setBidiRemoveMarksOnImplicitToVisual(boolean removeMarks)
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Setting bidi remove the directional marks only when transforming from logical to visual property:"+ removeMarks);
removeMarksOnImplicitToVisual_ = removeMarks;
}
/**
Indicates the value of the bidi remove the directional marks only when transforming from logical to visual property.
@return true if the remove the directional marks only when transforming from logical to visual property is enabled; false otherwise.
**/
public boolean isBidiRemoveMarksOnImplicitToVisual()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Checking if remove the directional marks only when transforming from logical to visual property is set:"+ removeMarksOnImplicitToVisual_);
return removeMarksOnImplicitToVisual_;
}
// Internal method to copy all the options from one object to another.
void copyOptionsTo(BidiTransform destination)
{
destination.impToImp = impToImp_;
destination.roundTrip = roundTrip_;
destination.winCompatible = winCompatible_;
destination.insertMarkers = insertMarkers_;
destination.removeMarkers = removeMarkers_;
if (options_ == 0)
{
destination.options = null;
}
else
{
destination.options.value = options_;
}
//@bd1a_start_ramysaid
ArabicOptionSet aos = new ArabicOptionSet();
aos.value = destination.options == null ? 0 : destination.options.value;
if (expandLamAlef) {
aos.setOneOption(ArabicOption.LAMALEF_RESIZE_BUFFER);
destination.options = new ArabicOptionSet(aos);
}
//@bd1a_end_ramysaid
destination.wordBreak = wordBreak_;
destination.destinationRequired = destinationRequired_;
destination.srcToDstMapRequired = srcToDstMapRequired_;
destination.dstToSrcMapRequired = dstToSrcMapRequired_;
destination.propertyMapRequired = propertyMapRequired_;
destination.continuation = continuation_;
setNumeralShapingOnTransform(destination);
}
/**
* Copy the numeral shaping options from this object into
* the destination transform
* @param destination transform
*/
void setNumeralShapingOnTransform(BidiTransform destination)
{
switch(numeralShaping_)
{
case NUMERALS_NOMINAL:
destination.flags.setOneFlag(BidiFlag.NUMERALS_NOMINAL);
break;
case NUMERALS_NATIONAL:
destination.flags.setOneFlag(BidiFlag.NUMERALS_NATIONAL);
break;
case NUMERALS_CONTEXTUAL:
destination.flags.setOneFlag(BidiFlag.NUMERALS_CONTEXTUAL);
break;
case NUMERALS_ANY:
destination.flags.setOneFlag(BidiFlag.NUMERALS_ANY);
break;
case NUMERALS_DEFAULT:
break;
}
}
/**
* Copy the numeral shaping options from the source transform
* into this object
* @param source transform
*/
void getNumeralShapingFromTransform(BidiTransform source)
{
BidiFlag flag = source.flags.getNumerals();
if (flag == BidiFlag.NUMERALS_NOMINAL) numeralShaping_ = NUMERALS_NOMINAL;
else if (flag == BidiFlag.NUMERALS_NATIONAL) numeralShaping_ = NUMERALS_NATIONAL;
else if (flag == BidiFlag.NUMERALS_CONTEXTUAL) numeralShaping_ = NUMERALS_CONTEXTUAL;
else if (flag == BidiFlag.NUMERALS_ANY) numeralShaping_ = NUMERALS_ANY;
}
/**
Sets the bidi implicit LTR-RTL reordering property. This property is true by default.
@param bidiImplicitReordering true to use the bidi implicit reordering; false otherwise.
**/
public void setBidiImplicitReordering(boolean bidiImplicitReordering)
{
if (Trace.traceConversion_) {
if (bidiImplicitReordering != oldBidiImplicitReordering) {
traceLog( Trace.DIAGNOSTIC, "Setting bidi implicit LTR-RTL reordering:"+ bidiImplicitReordering);
oldBidiImplicitReordering = bidiImplicitReordering;
}
}
impToImp_ = bidiImplicitReordering;
}
/**
Indicates the value of the bidi implicit LTR-RTL reordering property.
@return true if the bidi implicit LTR-RTL reordering property is enabled; false otherwise.
**/
public boolean isBidiImplicitReordering()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Checking if bidi implicit LTR-RTL reordering:"+ impToImp_);
return impToImp_;
}
/**
Sets the bidi numeric ordering round trip property. This property is false by default.
@param bidiNumericOrderingRoundTrip true to use the bidi numeric ordering round trip property; false otherwise.
**/
public void setBidiNumericOrderingRoundTrip(boolean bidiNumericOrderingRoundTrip)
{
if (Trace.traceConversion_) {
if (oldBidiNumericOrderingRoundTrip != bidiNumericOrderingRoundTrip) {
traceLog( Trace.DIAGNOSTIC, "Setting bidi numeric ordering round trip:"+ bidiNumericOrderingRoundTrip);
oldBidiNumericOrderingRoundTrip = bidiNumericOrderingRoundTrip;
}
}
roundTrip_ = bidiNumericOrderingRoundTrip;
}
/**
Indicates the value of the bidi numeric ordering round trip property.
@return true if the bidi numeric ordering round trip property is enabled; false otherwise.
**/
public boolean isBidiNumericOrderingRoundTrip()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Checking if bidi numeric ordering round trip:"+ roundTrip_);
return roundTrip_;
}
/**
Sets the bidi window compatibility property. This property is false by default.
If this option is true, the reordering algorithm is modified to perform more closely like Windows. In particular, logical string "12ABC" in LTR orientation (where ABC represent Arabic or Hebrew letters) is reordered as "CBA12" instead of "12CBA". Also, logical string "abc 123 45" (where all digits represent Hindi numbers) is reordered as "abc 123 45" instead of "abc 45 123".
@param bidiWindowCompatibility true to use the window compatibility property; false otherwise.
**/
public void setBidiWindowCompatibility(boolean bidiWindowCompatibility)
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Setting bidi window compatibility:"+ bidiWindowCompatibility);
winCompatible_ = bidiWindowCompatibility;
}
/**
Indicates the value of the bidi window compatibility property.
@return true if the bidi window compatibility property is enabled; false otherwise.
**/
public boolean isBidiWindowCompatibility()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Checking if bidi window compatibility:"+ winCompatible_);
return winCompatible_;
}
/**
Sets the bidi insert directional marks property. This property is false by default. Insert directional marks when going from visual to implicit to guarantee correct roundtrip back to visual.
@param bidiInsertDirectionalMarks true to use the insert directional marks property; false otherwise.
**/
public void setBidiInsertDirectionalMarks(boolean bidiInsertDirectionalMarks)
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Setting bidi insert directional marks:"+ bidiInsertDirectionalMarks);
insertMarkers_ = bidiInsertDirectionalMarks;
}
/**
Indicates the value of the bidi insert directional marks property.
@return true if the bidi insert directional marks property is enabled; false otherwise.
**/
public boolean isBidiInsertDirectionalMarks()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Checking if bidi insert directional marks:"+ insertMarkers_);
return insertMarkers_;
}
/**
Sets the bidi remove directional marks property. This property is false by default. Remove directional marks when going from implict to visual.
@param bidiRemoveDirectionalMarks true to use the remove directional marks property; false otherwise.
**/
public void setBidiRemoveDirectionalMarks(boolean bidiRemoveDirectionalMarks)
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Setting bidi remove directional marks:"+ bidiRemoveDirectionalMarks);
removeMarkers_ = bidiRemoveDirectionalMarks;
}
/**
Indicates the value of the bidi remove directional marks property.
@return true if the bidi remove directional marks property is enabled; false otherwise.
**/
public boolean isBidiRemoveDirectionalMarks()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Checking if bidi remove directional marks:"+ removeMarkers_);
return removeMarkers_;
}
/**
Sets the bidi consider white space to always follow base orientation property. This property is false by default.
@param wordBreak true to consider white space to always follow base orientation; false otherwise.
**/
public void setBidiWordBreak(boolean wordBreak)
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Setting bidi word break:"+ wordBreak);
wordBreak_ = wordBreak;
}
/**
Indicates the value of the bidi consider white space to always follow base orientation property.
@return true if the bidi consider white space to always follow base orientation property is enabled; false otherwise.
**/
public boolean isBidiWordBreak()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Checking if bidi consider white space to always follow base orientation:"+ wordBreak_);
return wordBreak_;
}
/**
Sets the numeral shaping property. By default this takes its value from the string type.
The possible values are:
- {@link #NUMERALS_NOMINAL NUMERALS_NOMINAL}
- {@link #NUMERALS_NATIONAL NUMERALS_NATIONAL}
- {@link #NUMERALS_CONTEXTUAL NUMERALS_CONTEXTUAL}
- {@link #NUMERALS_ANY NUMERALS_ANY}
- {@link #NUMERALS_DEFAULT NUMERALS_DEFAULT}
@param numeralShaping what shapes to use for numerals
**/
public void setBidiNumeralShaping(int numeralShaping)
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Setting numeral shaping:"+ numeralShaping);
if (numeralShaping < NUMERALS_DEFAULT || numeralShaping > NUMERALS_ANY)
{
throw new ExtendedIllegalArgumentException("numeralShaping (" + numeralShaping + ")", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
numeralShaping_ = numeralShaping;
}
/**
Gets the numeral shaping property. By default this takes its value from the string type.
The possible values are:
- {@link #NUMERALS_NOMINAL NUMERALS_NOMINAL}
- {@link #NUMERALS_NATIONAL NUMERALS_NATIONAL}
- {@link #NUMERALS_CONTEXTUAL NUMERALS_CONTEXTUAL}
- {@link #NUMERALS_ANY NUMERALS_ANY}
- {@link #NUMERALS_DEFAULT NUMERALS_DEFAULT}
@return what shapes to use for numerals
**/
public int getBidiNumeralShaping()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Checking numeral shaping:"+ numeralShaping_);
return numeralShaping_;
}
/**
Sets the bidi destination required property. This property is true by default.
@param destinationRequired true if the destination is required; false otherwise.
**/
public void setBidiDestinationRequired(boolean destinationRequired)
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Setting bidi destination required:"+ destinationRequired);
destinationRequired_ = destinationRequired;
}
/**
Indicates the value of the bidi destination required property.
@return true if the bidi destination required property is enabled; false otherwise.
**/
public boolean isBidiDestinationRequired()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Checking if bidi destination required:"+ destinationRequired_);
return destinationRequired_;
}
/**
Sets the create a source to destination mapping property. This property is false by default.
@param srcToDstMapRequired true to use the bidi create a source to destination mapping property; false otherwise.
**/
public void setBidiCreateSourceToDestinationMapping(boolean srcToDstMapRequired)
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Setting bidi create a source to destination mapping property:"+ srcToDstMapRequired);
srcToDstMapRequired_ = srcToDstMapRequired;
}
/**
Indicates the value of the bidi create a source to destination mapping property.
@return true if the bidi create a source to destination mapping property is enabled; false otherwise.
**/
public boolean isBidiCreateSourceToDestinationMapping()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Checking if create a source to destination mapping property is set:"+ srcToDstMapRequired_);
return srcToDstMapRequired_;
}
/**
Sets the create a destination to source mapping property. This property is false by default.
@param dstToSrcMapRequired true to use the create a destination to source mapping property; false otherwise.
**/
public void setBidiCreateDestinationToSourceMapping(boolean dstToSrcMapRequired)
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Setting bidi create a destination to source mapping property:"+ dstToSrcMapRequired);
dstToSrcMapRequired_ = dstToSrcMapRequired;
}
/**
Indicates the value of the bidi create a destination to source mapping property.
@return true if the bidi create a destination to source mapping property is enabled; false otherwise.
**/
public boolean isBidiCreateDestinationToSourceMapping()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Checking if create a destination to source mapping property is set:"+ dstToSrcMapRequired_);
return dstToSrcMapRequired_;
}
/**
Sets the create a property map property. This property is false by default.
@param propertyMapRequired true to use the create a property map property; false otherwise.
**/
public void setBidiCreatePropertyMap(boolean propertyMapRequired)
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Setting bidi create property map property:"+ propertyMapRequired);
propertyMapRequired_ = propertyMapRequired;
}
/**
Indicates the value of the bidi create a property map property.
@return true if the bidi create a property map property is enabled; false otherwise.
**/
public boolean isBidiCreatePropertyMap()
{
if (Trace.traceConversion_) traceLog( Trace.DIAGNOSTIC, "Checking if bidi create property map property is set:"+ propertyMapRequired_);
return propertyMapRequired_;
}
/**
Output value: number of characters processed in the source data by the last transform.
* @return input count
**/
public int getInputCount()
{
return inpCount_;
}
/**
Output value: number of characters written in the destination data by the last transform
* @return output count
**/
public int getOutputCount()
{
return outCount_;
}
/**
Output value: source-to-destination map from the last transform with srcToDstMapRequired specified; if this option was not specified, the content of srcToDstMap should be ignored.
If when starting a transformation this field refers to a large enough array of integers, this array will be re-used to put the new map. Otherwise a new array will be created.
This map has a number for each character processed in the source data by the last transform. This number is the index of where this character is moved in the character array of the destination BidiText. If the removeMarkers option was specified and LRM or RLM markers have been removed from the destination text, the corresponding elements of srcToDstMap will contain -1.
Note that the allocated array may have more elements than the number of characters processed in the source BidiText. In that case, the extra elements should be ignored. The number of relevant elements can be found from getInputCount()..
* @return map
**/
public int[] getSourceToDestinationMap()
{
return srcToDstMap_;
}
/**
Output value: destination-to-source map from the last transform with dstToSrcMapRequired specified; if this option was not specified, the content of dstToSrcMap should be ignored.
If when starting a transformation this field refers to a large enough array of integers, this array will be re-used to put the new map. Otherwise a new array will be created.
This map has a number for each character in the "interesting" data of the destination BidiText. This number is the index of the source character from which the destination character originates. This index is relative to the beginning of the "interesting" data. If the offset of the source BidiText is not zero, index 0 does not indicate the first character of the data array, but the character at position "offset". If the insertMarkers option was specified and LRM or RLM markers have been added, the corresponding elements of dstToSrcMap will contain -1.
Note that the allocated array may have more elements than the number of characters in the "interesting" part of the destination BidiText. In that case, the extra elements should be ignored. The number of relevant elements can be found from getOutputCount().
* @return map
**/
public int[] getDestinationToSourceMap()
{
return dstToSrcMap_;
}
/**
Output value: property map from the last transform with propertyMapRequired specified; if this option was not specified, the content of propertyMap should be ignored.
If when starting a transformation this field refers to a large enough array of bytes, this array will be re-used to put the new map. Otherwise a new array will be created.
This map has a byte for each character processed in the source data by the last transform. The 6 lower bits of each property element is the Bidi level of the corresponding input character. The highest bit is a new-cell indicator for composed character environments: a value of 0 indicates a zero-length composing character element, and a value of 1 indicates an element that begins a new cell.
Note: the content of this map has no simple interpretation if the bidi implicit reordering property is true.
Note also that the allocated array may have more elements than the number of characters processed in the source BidiText. In that case, the extra elements should be ignored. The number of relevant elements can be found from getInputCount().
* @return map
**/
public byte[] getPropertyMap()
{
return propertyMap_;
}
//@bd1a_start_ramysaid
/**
Indicates whether lam-alef ligatures should get decomposed into lam and alef characters
when transforming from visual to logical. Not the buffer may expand when this is done.
* @return are decomposed
**/
public boolean isBidiExpandLamAlef() {
return expandLamAlef;
}
/**
Sets whether lam-alef ligatures should get decomposed into lam and alef characters
when transforming from visual to logical.
* @param expandLamAlef
**/
public void setBidiExpandLamAlef(boolean expandLamAlef) {
this.expandLamAlef = expandLamAlef;
}
//@bd1a_end_ramysaid
/**
* @param category
* @param message
*/
public void traceLog(int category, String message) {
Trace.log(category, this.toString()+":"+message);
}
}