All Downloads are FREE. Search and download functionalities are using the official Maven repository.

src.com.ibm.as400.access.AS400BidiTransform Maven / Gradle / Ivy

There is a newer version: 20.0.7
Show newest version
///////////////////////////////////////////////////////////////////////////////
//
// JTOpen (IBM Toolbox for Java - OSS version)
//
// Filename:  AS400BidiTransform.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) 1997-2004 International Business Machines Corporation and
// others.  All rights reserved.
//
///////////////////////////////////////////////////////////////////////////////

package com.ibm.as400.access;

import java.sql.SQLException;

/**
 Provides layout transformations that allow the conversion of Bidi text in IBM i format (after its conversion to Unicode), to Bidi text in Java format; or vice-versa.
 

Bidi text is a combination of a sequence of characters and a set of Bidi flags. That text (Arabic or Hebrew) has characters which are read from right to left. That text might also be mixed with numbers which are read from left to right, and possibly also mixed with Latin characters. Conversion support is needed to display text properly with the correct order and shape.

Bidi text from an IBM i system may be represented by a combination of a String (the characters) and a CCSID (which implies a set of Bidi flags specific to that CCSID).

Multi-threading considerations: Different threads may use the same AS400BidiTransform object if they have the same transformation needs, as follows:

  • Same CCSID for the IBM i data.
  • Same string type for the IBM i data (if the default string type of the CCSID is used, this will result from using the same CCSID).
  • Same orientation for Java data (if the Java data orientation is derived from the IBM i string type, this will result from using the same string type for IBM i data).

Otherwise, each thread must use its own instances of this class.

The following examples illustrate how to transform bidi text:

 * // Java data to IBM i layout:
 * AS400BidiTransform abt;
 * abt = new AS400BidiTransform(424);
 * String dst = abt.toAS400Layout("some bidi string");
 *
 * // Specifying a new CCSID for an existing AS400BidiTransform object:
 * abt.setAS400Ccsid(62234);                    // 420 RTL //
 * String dst = abt.toAS400Layout("some bidi string");
 *
 * // Specifying a non-default string type for a given CCSID:
 * abt.setAS400StringType(BidiStringType.ST4);  // Vis LTR //
 * String dst = abt.toAS400Layout("some bidi string");
 *
 * // Specifying a non-default string type for Java data:
 * abt.setJavaStringType(BidiStringType.ST11);  // Imp Context LTR //
 * String dst = abt.toAS400Layout("some bidi string");
 *
 * // How to transform IBM i data to Java layout:
 * abt.setJavaStringType(BidiStringType.ST6);   // Imp RTL //
 * String dst = abt.toJavaLayout("some bidi string");
 
A more simplified method is to use {@link #bidiTransform(String,int,int) bidiTransform()}. The following example illustrates how to use it:
 String src = "some bidi string";
 String result = AS400BidiTransform.bidiTransform(src, BidiStringType.ST4,  BidiStringType.ST6); // from visual LTR to Implicit RTL //
 
**/ public class AS400BidiTransform { static final int ST1 = 1; static final int ST2 = 2; static final int ST3 = 3; static final int ST4 = 4; static final int ST5 = 5; static final int ST6 = 6; static final int ST7 = 7; static final int ST8 = 8; static final int ST9 = 9; static final int ST10 = 10; static final int ST11 = 11; static final int ST12 = 12; static final int ST13 = 13; static final int ST14 = 14; private static final int[][] CCSID_TABLE = { // CCSID, String-Type { 420, ST4 }, // Arabic.420 { 424, ST4 }, // Hebrew.424 { 425, ST5 }, // Arabic/Latin EBCDIC defined for OS/390 open edition. { 856, ST5 }, // Hebrew.856 { 862, ST4 }, // Hebrew.862 { 864, ST5 }, // Arabic.864 { 867, ST4 }, // Hebrew.867 { 916, ST5 }, // Hebrew.916 { 1046, ST5 }, // Arabic.1046 { 1089, ST5 }, // Arabic.1089 { 1255, ST5 }, // Hebrew.1255 { 1256, ST5 }, // Arabic.1256 { 5012, ST5 }, // Hebrew.916 { 5351, ST5 }, // Hebrew.1255 { 5352, ST5 }, // Arabic.1256 { 8612, ST5 }, // Arabic.420 { 8616, ST10 }, // Hebrew.424 { 9238, ST5 }, // Arabic.1046 { 12708, ST7 }, // Arabic.420 { 12712, ST10 }, // Hebrew.424 { 13488, ST10 }, // Unicode.10646 { 16804, ST4 }, // Arabic.420 { 17248, ST5 }, // Arabic.864 { 61952, ST10 }, // Unicode.10646 { 62208, ST4 }, // Hebrew.856 { 62209, ST10 }, // Hebrew.862 { 62210, ST4 }, // Hebrew.916 { 62211, ST5 }, // Hebrew.424 { 62212, ST10 }, // Hebrew.867 { 62213, ST5 }, // Hebrew.862 { 62214, ST5 }, // Hebrew.867 { 62215, ST4 }, // Hebrew.1255 { 62216, ST6 }, // Hebrew.867 { 62217, ST8 }, // Hebrew.867 { 62218, ST4 }, // Arabic.864 { 62219, ST11 }, // Hebrew.867 { 62220, ST6 }, // Hebrew.856 { 62221, ST6 }, // Hebrew.862 { 62222, ST6 }, // Hebrew.916 { 62223, ST6 }, // Hebrew.1255 { 62224, ST6 }, // Arabic.420 { 62225, ST6 }, // Arabic.864 { 62226, ST6 }, // Arabic.1046 { 62227, ST6 }, // Arabic.1089 { 62228, ST6 }, // Arabic.1256 { 62229, ST8 }, // Hebrew.424 { 62230, ST8 }, // Hebrew.856 { 62231, ST8 }, // Hebrew.862 { 62232, ST8 }, // Hebrew.916 { 62233, ST8 }, // Arabic.420 { 62234, ST9 }, // Arabic.420 { 62235, ST6 }, // Hebrew.424 { 62236, ST10 }, // Hebrew.856 { 62237, ST8 }, // Hebrew.1255 { 62238, ST10 }, // Hebrew.916 { 62239, ST10 }, // Hebrew.1255 { 62240, ST11 }, // Hebrew.424 { 62241, ST11 }, // Hebrew.856 { 62242, ST11 }, // Hebrew.862 { 62243, ST11 }, // Hebrew.916 { 62244, ST11 }, // Hebrew.1255 { 62245, ST10 }, // Hebrew.424 { 62251, ST6 } // Arabic.425 - Used for OS/390. }; private static final int CCSID_MAX = CCSID_TABLE.length - 1; private static final BidiFlagSet[] FLAG_SET = new BidiFlagSet[12]; private static final BidiFlagSet NORMAL_FLAG_SET = initFlagSet(0); private int as400Ccsid_; // Server CCSID. private int as400Type_; // String type of server data. private int javaType_; // String type of Java data. private BidiTransform bdxJ2A_ = new BidiTransform(); // From Java to server. private BidiTransform bdxA2J_ = new BidiTransform(); // From server to Java. private BidiTransform lastTransform_ = bdxA2J_; // Keeps track of which transform was used last. /** Constructs an AS400BidiTransform object assuming that the IBM i Bidi text conforms to a given CCSID. Typically this will be the CCSID of the system.

The given CCSID has a default string type which defines a set of Bidi flags. The orientation implied by this string type is applied to both the IBM i data layout and the Java data layout. @param as400Ccsid The CCSID of the IBM i data. **/ public AS400BidiTransform(int as400Ccsid) { bdxA2J_.flags = new BidiFlagSet(NORMAL_FLAG_SET); setAS400Ccsid(as400Ccsid); setJavaStringType(BidiStringType.DEFAULT);//Bidi-HCG //setJavaStringType(BidiStringType.ST5);//Bidi-HCG } /** Indicates if a given CCSID may apply to Bidi data. This is the case for Arabic and Hebrew CCSIDs, and for Unicode (which can encode anything).

If a CCSID is not Bidi, there is no need to perform layout transformations when converting IBM i data to Java data and vice-versa. @param ccsid The CCSID to check. @return true if the given CCSID may apply to Bidi data, false otherwise. **/ public static boolean isBidiCcsid(int ccsid) { switch (ccsid) { case 420: case 424: case 425: case 856: case 862: case 864: case 867: case 916: case 1046: case 1089: case 1255: case 1256: case 5012: case 5351: case 5352: case 8612: case 8616: case 9238: case 12708: case 12712: case 13488: case 16804: case 17248: case 61952: case 62208: case 62209: case 62210: case 62211: case 62212: case 62213: case 62214: case 62215: case 62216: case 62217: case 62218: case 62219: case 62220: case 62221: case 62222: case 62223: case 62224: case 62225: case 62226: case 62227: case 62228: case 62229: case 62230: case 62231: case 62232: case 62233: case 62234: case 62235: case 62236: case 62237: case 62238: case 62239: case 62240: case 62241: case 62242: case 62243: case 62244: case 62245: case 62251: return true; default: return false; } } /** Indicates if a given CCSID has a visual string type. @param ccsid The CCSID to check. @return true if the given CCSID has a visual string type, false otherwse. **/ public static boolean isVisual(int ccsid) { int st = getStringType(ccsid); if (st == ST4 || st == ST7 || st == ST8 || st == ST9) return true; return false; } /** Sets the CCSID.

The given CCSID has a default string type which defines a set of Bidi flags. The orientation implied by this string type is applied to both the IBM i data layout and the Java data layout. @param as400Ccsid The CCSID of the IBM i data. **/ public void setAS400Ccsid(int as400Ccsid) { as400Ccsid_ = as400Ccsid; setAS400StringType(getStringType(as400Ccsid)); } /** Returns the current CCSID of IBM i data. @return The CCSID for the IBM i data. **/ public int getAS400Ccsid() { return as400Ccsid_; } /** Set the explicit string type for the IBM i data. Each CCSID has a default CDRA string type, which defines a set of Bidi flags. This method may be used to specify Bidi flags different from those implied by the CCSID. @param as400Type The string type to apply to the IBM i data. The parameter string type should always be one of the constants defined in BidiStringType. @see com.ibm.as400.access.BidiStringType **/ public void setAS400StringType(int as400Type) { //Bidi-HCG - delete this section //if (as400Type != BidiStringType.DEFAULT && (as400Type < BidiStringType.ST4 || as400Type > BidiStringType.ST11)) //{ // Trace.log(Trace.ERROR, "Attempting to set the as400 string type to an invalid Bidi sting type."); // throw new ExtendedIllegalArgumentException("as400Type", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID); //} as400Type_ = as400Type; if (FLAG_SET[as400Type] == null) FLAG_SET[as400Type] = initFlagSet(as400Type); bdxJ2A_.flags = FLAG_SET[as400Type]; //Bidi-HCG setJavaStringType(as400Type); } /** Returns the current string type of the IBM i data. @return The string type of the IBM i data. **/ public int getAS400StringType() { return as400Type_; } /** Set the explicit string type for Java data. @see com.ibm.as400.access.BidiStringType @param javaType The string type to apply to Java data. **/ public void setJavaStringType(int javaType) { //if (javaType != BidiStringType.DEFAULT && (javaType < BidiStringType.ST4 || javaType > BidiStringType.ST11)) //{ // Trace.log(Trace.ERROR, "Attempting to set the java string type to an invalid Bidi sting type."); // throw new ExtendedIllegalArgumentException("javaType", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID); //} //if (FLAG_SET[javaType] == null) FLAG_SET[javaType] = initFlagSet(javaType); //BidiFlag orient = FLAG_SET[javaType].getOrientation(); // Copy orientation from javaType to bdxA2J_.flags. //bdxA2J_.flags.setOneFlag(orient); //if (orient == BidiFlag.ORIENTATION_LTR) javaType_ = 5; //else if (orient == BidiFlag.ORIENTATION_RTL) javaType_ = 6; //else if (orient == BidiFlag.ORIENTATION_CONTEXT_LTR) javaType_ = 10; //else if (orient == BidiFlag.ORIENTATION_CONTEXT_RTL) javaType_ = 11; //else javaType_ = 5; // Must never happen. javaType_ = javaType;//Bidi-HCG bdxA2J_.flags = initFlagSet(javaType);//Bidi-HCG } /** Returns the current string type of Java data. @return The string type of the Java data. **/ public int getJavaStringType() { return javaType_; } /** Sets the bidi conversion properties. @param properties The bidi conversion properties. **/ public void setBidiConversionProperties(BidiConversionProperties properties) { setJavaStringType(properties.getBidiStringType());//Bidi-HCG properties.copyOptionsTo(bdxJ2A_); properties.copyOptionsTo(bdxA2J_); if (properties.isBidiRemoveMarksOnImplicitToVisual()) { bdxJ2A_.removeMarkers=true; bdxA2J_.removeMarkers=false; } //Bidi-HCG setJavaStringType(properties.getBidiStringType()); } /** Returns the bidi conversion properties. @return The bidi conversion properties. **/ public BidiConversionProperties getBidiConversionProperties() { boolean removeMarksOnJ2A = (bdxJ2A_.removeMarkers==true && bdxA2J_.removeMarkers==false); return new BidiConversionProperties(getJavaStringType(),lastTransform_, removeMarksOnJ2A); } /** Convert data from the IBM i layout to the Java layout. @param as400Text The IBM i string to convert. @return The same text in standard Java Bidi layout. **/ public String toJavaLayout(String as400Text) { lastTransform_ = bdxA2J_; if(as400Type_ == BidiStringType.NONE || javaType_ == BidiStringType.NONE || javaType_ == as400Type_) //Bidi-HCG2 return as400Text; //Bidi-HCG BidiText src = new BidiText(bdxJ2A_.flags, as400Text); return src.transform(bdxA2J_).toString(); } /** Convert data from the Java layout to the IBM i layout. @param javaText The Java string to convert. @return The same text in IBM i Bidi layout. **/ public String toAS400Layout(String javaText) { lastTransform_ = bdxJ2A_; if(as400Type_ == BidiStringType.NONE || javaType_ == BidiStringType.NONE || javaType_ == as400Type_) //Bidi-HCG2 return javaText; //Bidi-HCG BidiText src = new BidiText(bdxA2J_.flags, javaText); return src.transform(bdxJ2A_).toString(); } /** * Returns Bidi string type defined for CCSID * @param ccsid * @return Bidi string type */ public static int getStringType(int ccsid) { // Return default string type for parm ccsid based on CCSID_TABLE. int low = 0; int high = CCSID_MAX; while (low < high) { int mid = (low + high) >>> 1; // same as division by 2, but eliminates possibility of overflow if (ccsid < CCSID_TABLE[mid][0]) high = mid - 1; else if (ccsid > CCSID_TABLE[mid][0]) low = mid + 1; else return CCSID_TABLE[mid][1]; } if ((low == high) && (ccsid == CCSID_TABLE[low][0])) return CCSID_TABLE[low][1]; return 0; } //Bidi-HCG1 static int getStringTypeM(int ccsid){ if(ccsid == 13488 || ccsid == 1200) return ST5; else return getStringType(ccsid); } //Bidi-HCG3 public static int getStringTypeX(int ccsid, AS400 as400){ if(as400 == null) return getStringType(ccsid); if(ccsid == 13488 || ccsid == 1200){ boolean v5r1 = false; try { v5r1 = (as400.getVersion()==5) && (as400.getRelease()==1); } catch (AS400SecurityException e) { //do nothing } catch (java.io.IOException e) { //do nothing } if(isBidiCcsid(as400.getCcsid()) && (!v5r1)) return ST10; else return ST5; } else return getStringType(ccsid); } // Return BidiFlagSet according to string type. private static BidiFlagSet initFlagSet(int stringType) { switch (stringType) { case ST4: return new BidiFlagSet(BidiFlag.TYPE_VISUAL, BidiFlag.NUMERALS_NOMINAL, BidiFlag.ORIENTATION_LTR, BidiFlag.TEXT_SHAPED, BidiFlag.SWAP_NO); case ST5: return new BidiFlagSet(BidiFlag.TYPE_IMPLICIT, BidiFlag.NUMERALS_NOMINAL, BidiFlag.ORIENTATION_LTR, BidiFlag.TEXT_NOMINAL, BidiFlag.SWAP_YES); case ST6: return new BidiFlagSet(BidiFlag.TYPE_IMPLICIT, BidiFlag.NUMERALS_NOMINAL, BidiFlag.ORIENTATION_RTL, BidiFlag.TEXT_NOMINAL, BidiFlag.SWAP_YES); case ST7: return new BidiFlagSet(BidiFlag.TYPE_VISUAL, BidiFlag.NUMERALS_NOMINAL, BidiFlag.ORIENTATION_CONTEXT_LTR, BidiFlag.TEXT_NOMINAL, BidiFlag.SWAP_NO); case ST8: return new BidiFlagSet(BidiFlag.TYPE_VISUAL, BidiFlag.NUMERALS_NOMINAL, BidiFlag.ORIENTATION_RTL, BidiFlag.TEXT_SHAPED, BidiFlag.SWAP_NO); case ST9: return new BidiFlagSet(BidiFlag.TYPE_VISUAL, BidiFlag.NUMERALS_NOMINAL, BidiFlag.ORIENTATION_RTL, BidiFlag.TEXT_SHAPED, BidiFlag.SWAP_YES); case ST10: return new BidiFlagSet(BidiFlag.TYPE_IMPLICIT, BidiFlag.NUMERALS_NOMINAL, BidiFlag.ORIENTATION_CONTEXT_LTR, BidiFlag.TEXT_NOMINAL, BidiFlag.SWAP_YES); case ST11: return new BidiFlagSet(BidiFlag.TYPE_IMPLICIT, BidiFlag.NUMERALS_NOMINAL, BidiFlag.ORIENTATION_CONTEXT_RTL, BidiFlag.TEXT_NOMINAL, BidiFlag.SWAP_YES); default: return new BidiFlagSet(BidiFlag.TYPE_IMPLICIT, BidiFlag.NUMERALS_NOMINAL, //BidiFlag.ORIENTATION_CONTEXT_LTR, BidiFlag.ORIENTATION_LTR,//Bidi-HCG1 BidiFlag.TEXT_NOMINAL, BidiFlag.SWAP_YES); } } //Bidi-HCG start /** Bidi-HCG Perform Bidi layout transformation by given Bidi string types. @param str The Java string to convert. @param inFormat Input format. @param outFormat Output format. @return The same text after Bidi layout transformation. **/ public static String bidiTransform(String str, int inFormat, int outFormat){ if (Trace.traceOn_) Trace.log(Trace.CONVERSION, "Bidi layout transformation from " + inFormat + " to " + outFormat + ", string: " + str); if(inFormat == outFormat) return str; if(inFormat == BidiStringType.NONE || outFormat == BidiStringType.NONE) return str; BidiTransform bdx = new BidiTransform(); BidiFlagSet flagsIn = initFlagSet(inFormat); BidiFlagSet flagsOut = initFlagSet(outFormat); bdx.flags = flagsOut; bdx.removeMarkers = true;//Bidi-HCG1 BidiText textIn = new BidiText(flagsIn,str); BidiText textOut = textIn.transform(bdx); String strOut = textOut.toString(); return strOut; } /** * Bidi-HCG * Perform Bidi layout transformation of a data into SQL statement. Meta-data (names of columns etc.) is kept untouched. * @param value_ Given SQL statement. * @param inFormat Input format. * @param outFormat Output format. * @return The SQL statement after the Bidi layout transformation. */ public static String SQL_statement_reordering(String value_, int inFormat, int outFormat){ if (Trace.traceOn_) Trace.log(Trace.CONVERSION, "Bidi layout transformation from " + inFormat + " to " + outFormat + " of SQL statement: " + value_); if(inFormat == outFormat) return value_; if(inFormat == BidiStringType.NONE || outFormat == BidiStringType.NONE) return value_; boolean into = false; int i = 0, start = 0, end = 0; String str; while(i< value_.length()){ if(into && (value_.charAt(i) == '\n' || value_.charAt(i) == '\r')){ end = i; str = value_.substring(start, end); str = bidiTransform(str, inFormat, outFormat); value_ = value_.substring(0, start) + str + value_.substring(end); start = i + 1; } if(value_.charAt(i) == '\''){ if(into) { if(i + 1 < value_.length()) if(value_.charAt(i+1) == '\''){ i = i + 2; continue; } end = i; str = value_.substring(start, end); str = bidiTransform(str, inFormat, outFormat); value_ = value_.substring(0, start) + str + value_.substring(end); start = end = 0; into = false; } else { into = true; start = i+1; } } i++; } return value_; } public static String meta_data_reordering(String value_, int inFormat, int outFormat) { if (Trace.traceOn_) Trace.log(Trace.CONVERSION, "Bidi layout transformation of SQL meta-data: " + value_); if(inFormat == outFormat) return value_; if(inFormat == BidiStringType.NONE || outFormat == BidiStringType.NONE) return value_; boolean into = false; int i = 0, start = 0, end = 0; String str; while(i< value_.length()){ if(value_.charAt(i) == '"'){ if(into){ end = i; str = value_.substring(start, end); str = bidiTransform(str, inFormat, outFormat); value_ = value_.substring(0, start) + str + value_.substring(end); start = end = 0; into = false; } else { into = true; start = i+1; } } i++; } return value_; } static String convertSQLToHostCCSID(String value_, AS400JDBCConnection connection) throws SQLException{ if(connection == null || value_ == null) //@pdc return value_; JDProperties prop = connection.getProperties(); int host_bidi_format, host_ccsid, package_bidi_format, package_ccsid; int bidi_format = prop.getInt(JDProperties.BIDI_STRING_TYPE); if(connection.getSystem() != null){ //@pdc host_ccsid = connection.getSystem().getCcsid(); host_bidi_format = getStringType(host_ccsid); } else host_bidi_format = 4; package_ccsid = connection.getProperties().getInt(JDProperties.PACKAGE_CCSID); package_bidi_format = getStringTypeX(package_ccsid, connection.getSystem()); //Bidi-HCG3 if(bidi_format != BidiStringType.NONE && host_bidi_format != BidiStringType.NONE){//Bidi-HCG3 if(prop.getString(JDProperties.BIDI_IMPLICIT_REORDERING).equalsIgnoreCase("true")) value_ = meta_data_reordering(value_, bidi_format, host_bidi_format); value_ = SQL_statement_reordering(value_, bidi_format, package_bidi_format); } return value_; } //Bidi-HCG2: Remove this method, and re-implement ConvTableBidiMap.stringToByteArray() instead. // static String convertDataToHostCCSID(String value_, AS400JDBCConnection connection, int host_ccsid) throws SQLException{ // if(connection == null || value_ == null) //@pdc // return value_; // JDProperties prop = connection.getProperties(); // int bidi_format = prop.getInt(JDProperties.BIDI_STRING_TYPE); // int host_bidi_format = getStringTypeX(host_ccsid, connection.getSystem()); // if(bidi_format != 0 && host_bidi_format != 0){ // value_ = bidiTransform(value_, bidi_format, host_bidi_format); // } // return value_; // } static String convertDataFromHostCCSID(String value_, AS400JDBCConnection connection, int host_ccsid) throws SQLException{ if(connection == null || value_ == null) //@pdc return value_; JDProperties prop = connection.getProperties(); int host_bidi_format; int bidi_format = prop.getInt(JDProperties.BIDI_STRING_TYPE); host_bidi_format = getStringTypeX(host_ccsid, connection.getSystem()); if(host_bidi_format == 0){ if(connection.getSystem() != null){ host_ccsid = connection.getSystem().getCcsid(); host_bidi_format = getStringType(host_ccsid); } else host_bidi_format = 4; } if(bidi_format != 0 && host_bidi_format != 0){ value_ = bidiTransform(value_, host_bidi_format, bidi_format); } return value_; } //Bidi-HCG end }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy