psdi.iface.bidi.maximo

Class MaximoBidiTransformer

java.lang.Object

psdi.iface.bidi.maximo.MaximoBidiTransformer

public class MaximoBidiTransformer
extends java.lang.Object

Wrapper to provide APIs for Bidi Transformation for Maximo.

Author:

Hatim Mohammed (hatim@eg.ibm.com) -- Based on code by Karim Badr (karim@eg.ibm.com)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ERR_KEY_BAD_XML_DOCUMENT Error bundle key: Bad XML document passed for processing
static java.lang.String	ERR_KEY_INVALID_ATTRIBUTES Error bundle key: Bidi FlagSet has bad character(s), or not disallowed combination of attributes.
static java.lang.String	ERR_KEY_INVALID_IN_OUT_ATTRIBUTES Error bundle key: In & Out attributes either equal or conflicting
static java.lang.String	ERR_KEY_NULL_ATTRIBUTES Error bundle key: Null Bidi attributes set
static java.lang.String	ERR_KEY_NULL_XML_DOCUMENT Error bundle key: Null XML document passed for processing
static java.lang.String	MAXIMO_INBOUND_ILYNN Maximo's inbound Bidi flags.
static java.lang.String	MAXIMO_OUTBOUND_ICYNN Maximo's outbound Bidi flags.

Method Summary

Modifier and Type	Method and Description
static org.jdom.Document	transformFromMaximoFormat(org.jdom.Document inDoc, java.lang.String outFormat) Transform the input org.jdom.Document using the Maximo Bidi layout format to output Bidi layout format (inbound).
static org.jdom.Document	transformFromMaximoFormat(org.jdom.Document inDoc, java.lang.String outFormat, java.util.Set<java.lang.String> exclusionsSet) Transform the input org.jdom.Document using the Maximo Bidi layout format to output Bidi layout format (inbound).
static org.jdom.Document	transformFromMaximoFormat(org.jdom.Document inDoc, java.lang.String outFormat, java.util.Set<java.lang.String> exclusionsSet, boolean transformAttributes) Transform the input org.jdom.Document using the Maximo Bidi layout format to output Bidi layout format (inbound).
static java.util.List<java.lang.String>	transformFromMaximoFormat(java.util.List<java.lang.String> inStrs, java.lang.String outFormat) Transform batch of strings using the Maximo Bidi layout format to output Bidi layout format (inbound).
static java.util.List<java.lang.String>	transformFromMaximoFormat(java.util.List<java.lang.String> inStrs, java.lang.String outFormat, java.util.Map<java.lang.Integer,MXApplicationException> errors) Transform batch of strings using the Maximo Bidi layout format to output Bidi layout format (inbound).
static java.lang.String	transformFromMaximoFormat(java.lang.String text, java.lang.String outFormat) Transform text from Maximo Bidi layout format to external Bidi layout format (outbound)
static org.jdom.Document	transformToMaximoFormat(org.jdom.Document inDoc, java.lang.String inFormat) Transform the input org.jdom.Document using the input Bidi layout format to Maximo Bidi layout format (outbound).
static org.jdom.Document	transformToMaximoFormat(org.jdom.Document inDoc, java.lang.String inFormat, java.util.Set<java.lang.String> exclusionsSet) Transform the input org.jdom.Document using the input Bidi layout format to Maximo Bidi layout format (outbound).
static org.jdom.Document	transformToMaximoFormat(org.jdom.Document inDoc, java.lang.String inFormat, java.util.Set<java.lang.String> exclusionsSet, boolean transformAttributes) Transform the input org.jdom.Document using the input Bidi layout format to Maximo Bidi layout format (outbound).
static java.util.List<java.lang.String>	transformToMaximoFormat(java.util.List<java.lang.String> inStrs, java.lang.String inFormat) Transform batch of strings using the input Bidi layout format to Maximo Bidi layout format (outbound).
static java.util.List<java.lang.String>	transformToMaximoFormat(java.util.List<java.lang.String> inStrs, java.lang.String inFormat, java.util.Map<java.lang.Integer,MXApplicationException> errors) Transform batch of strings using the input Bidi layout format to Maximo Bidi layout format (outbound).
static java.lang.String	transformToMaximoFormat(java.lang.String text, java.lang.String inFormat) Transform text from external Bidi layout format to Maximo Bidi layout format (inbound)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAXIMO_INBOUND_ILYNN

public static final java.lang.String MAXIMO_INBOUND_ILYNN

Maximo's inbound Bidi flags. (Implicit, Left-To-Right, swapping on, nominal text shaping (unshaped), nominal numeral shaping (Arabic))

See Also:

Constant Field Values

MAXIMO_OUTBOUND_ICYNN

public static final java.lang.String MAXIMO_OUTBOUND_ICYNN

Maximo's outbound Bidi flags. (Implicit, Contextual Left-To-Right, swapping on, nominal text shaping (unshaped), nominal numeral shaping (Arabic))

See Also:

Constant Field Values

ERR_KEY_INVALID_ATTRIBUTES

public static final java.lang.String ERR_KEY_INVALID_ATTRIBUTES

Error bundle key: Bidi FlagSet has bad character(s), or not disallowed combination of attributes.

See Also:

Constant Field Values

ERR_KEY_INVALID_IN_OUT_ATTRIBUTES

public static final java.lang.String ERR_KEY_INVALID_IN_OUT_ATTRIBUTES

Error bundle key: In & Out attributes either equal or conflicting

See Also:

Constant Field Values

ERR_KEY_NULL_ATTRIBUTES

public static final java.lang.String ERR_KEY_NULL_ATTRIBUTES

Error bundle key: Null Bidi attributes set

See Also:

Constant Field Values

ERR_KEY_NULL_XML_DOCUMENT

public static final java.lang.String ERR_KEY_NULL_XML_DOCUMENT

Error bundle key: Null XML document passed for processing

See Also:

Constant Field Values

ERR_KEY_BAD_XML_DOCUMENT

public static final java.lang.String ERR_KEY_BAD_XML_DOCUMENT

Error bundle key: Bad XML document passed for processing

See Also:

Constant Field Values

Method Detail

transformToMaximoFormat

public static java.lang.String transformToMaximoFormat(java.lang.String text,
                                                       java.lang.String inFormat)
                                                throws MXApplicationException

Transform text from external Bidi layout format to Maximo Bidi layout format (inbound)

Parameters:

text - text to be transformed

inFormat - input Bidi format parameters

Returns:

transformed text

Throws:

MXApplicationException - transforms the exception thrown from the base API.

transformToMaximoFormat

public static java.util.List<java.lang.String> transformToMaximoFormat(java.util.List<java.lang.String> inStrs,
                                                                       java.lang.String inFormat)
                                                                throws MXApplicationException

Transform batch of strings using the input Bidi layout format to Maximo Bidi layout format (outbound). Formats are supplied into Bidi FlagSet format. See BidiFlags

Parameters:

inStrs - Input String list

inFormat - Input Bidi flag set format parameters

Returns:

transformed Strings into an List. Returned list may contain null values to indicate errors happened while text transformation.

Throws:

MXApplicationException - exception is thrown in case of initialization failure Null's in the returned list should be anticipated if the transformation/reshaping fails in the batch.

transformToMaximoFormat

public static java.util.List<java.lang.String> transformToMaximoFormat(java.util.List<java.lang.String> inStrs,
                                                                       java.lang.String inFormat,
                                                                       java.util.Map<java.lang.Integer,MXApplicationException> errors)
                                                                throws MXApplicationException

Transform batch of strings using the input Bidi layout format to Maximo Bidi layout format (outbound). Formats are supplied into Bidi FlagSet format. See BidiFlags

Parameters:

inStrs - Input String list

inFormat - Input Bidi flag set format parameters

errors - Map to hold the exceptions thrown particularly thru any transformation. If null, no errors will be logged.

Returns:

transformed Strings into an List

Throws:

MXApplicationException - exception is thrown in case of initialization failure Null's in the returned list should be anticipated if the transformation/reshaping fails in the batch.

transformToMaximoFormat

public static org.jdom.Document transformToMaximoFormat(org.jdom.Document inDoc,
                                                        java.lang.String inFormat)
                                                 throws MXApplicationException

Transform the input org.jdom.Document using the input Bidi layout format to Maximo Bidi layout format (outbound). Formats are supplied into Bidi FlagSet format. See BidiFlags

Parameters:

inDoc - Input XML document. If null, IllegalArgumentException will be thrown.

inFormat - Input Bidi flag-set format parameters

exclusionsSet is set to null

transformAttributes is set to false

Returns:

transformed JDOM XML document

Throws:

MXApplicationException

transformToMaximoFormat

public static org.jdom.Document transformToMaximoFormat(org.jdom.Document inDoc,
                                                        java.lang.String inFormat,
                                                        java.util.Set<java.lang.String> exclusionsSet)
                                                 throws MXApplicationException

Transform the input org.jdom.Document using the input Bidi layout format to Maximo Bidi layout format (outbound). Formats are supplied into Bidi FlagSet format. See BidiFlags

Parameters:

inDoc - Input XML document. If null, IllegalArgumentException will be thrown.

inFormat - Input Bidi flag-set format parameters

exclusionsSet - the list of unique text entries those shouldn't be processed by the Bidi transformer. Exclusion for a node doesn't exclude its children.

transformAttributes is set to false

Returns:

transformed JDOM XML document

Throws:

MXApplicationException

transformToMaximoFormat

public static org.jdom.Document transformToMaximoFormat(org.jdom.Document inDoc,
                                                        java.lang.String inFormat,
                                                        java.util.Set<java.lang.String> exclusionsSet,
                                                        boolean transformAttributes)
                                                 throws MXApplicationException

Transform the input org.jdom.Document using the input Bidi layout format to Maximo Bidi layout format (outbound). Formats are supplied into Bidi FlagSet format. See BidiFlags

Parameters:

inDoc - Input XML document. If null, IllegalArgumentException will be thrown.

inFormat - Input Bidi flag-set format parameters

exclusionsSet - the list of unique text entries those shouldn't be processed by the Bidi transformer. Exclusion for a node doesn't exclude its children.

transformAttributes - decides whether to transform the values of element's attributes or not

Returns:

transformed JDOM XML document

Throws:

MXApplicationException

transformFromMaximoFormat

public static java.lang.String transformFromMaximoFormat(java.lang.String text,
                                                         java.lang.String outFormat)
                                                  throws MXApplicationException

Transform text from Maximo Bidi layout format to external Bidi layout format (outbound)

Parameters:

text - text to be transformed

outFormat - output Bidi format parameters

Throws:

MXApplicationException - transforms the exception thrown from the base API.

transformFromMaximoFormat

public static java.util.List<java.lang.String> transformFromMaximoFormat(java.util.List<java.lang.String> inStrs,
                                                                         java.lang.String outFormat)
                                                                  throws MXApplicationException

Transform batch of strings using the Maximo Bidi layout format to output Bidi layout format (inbound). Formats are supplied into Bidi FlagSet format. See BidiFlags

Parameters:

inStrs - Input String list

outFormat - Output Bidi flag set format parameters

Returns:

transformed Strings into an List. Returned list may contain null values to indicate errors happened while text transformation.

Throws:

MXApplicationException - exception is thrown in case of initialization failure Null's in the returned list should be anticipated if the transformation/reshaping fails in the batch.

transformFromMaximoFormat

public static java.util.List<java.lang.String> transformFromMaximoFormat(java.util.List<java.lang.String> inStrs,
                                                                         java.lang.String outFormat,
                                                                         java.util.Map<java.lang.Integer,MXApplicationException> errors)
                                                                  throws MXApplicationException

Transform batch of strings using the Maximo Bidi layout format to output Bidi layout format (inbound). Formats are supplied into Bidi FlagSet format. See BidiFlags

Parameters:

inStrs - Input String list

outFormat - Output Bidi format set parameters

errors - Map to hold the exceptions thrown particularly thru any transformation. If null, no errors will be logged.

Returns:

transformed Strings into an List

Throws:

MXApplicationException - exception is thrown in case of initialization failure Null's in the returned list should be anticipated if the transformation/reshaping fails in the batch.

transformFromMaximoFormat

public static org.jdom.Document transformFromMaximoFormat(org.jdom.Document inDoc,
                                                          java.lang.String outFormat)
                                                   throws MXApplicationException

Transform the input org.jdom.Document using the Maximo Bidi layout format to output Bidi layout format (inbound). Formats are supplied into Bidi FlagSet format. See BidiFlags

Parameters:

inDoc - Input XML document. If null, IllegalArgumentException will be thrown.

outFormat - Output Bidi flag-set format parameters

exclusionsSet is set to null

transformAttributes is set to false

Returns:

transformed JDOM XML document

Throws:

MXApplicationException

transformFromMaximoFormat

public static org.jdom.Document transformFromMaximoFormat(org.jdom.Document inDoc,
                                                          java.lang.String outFormat,
                                                          java.util.Set<java.lang.String> exclusionsSet)
                                                   throws MXApplicationException

Transform the input org.jdom.Document using the Maximo Bidi layout format to output Bidi layout format (inbound). Formats are supplied into Bidi FlagSet format. See BidiFlags

Parameters:

inDoc - Input XML document. If null, IllegalArgumentException will be thrown.

outFormat - Output Bidi flag-set format parameters

exclusionsSet - the list of unique text entries those shouldn't be processed by the Bidi transformer. Exclusion for a node doesn't exclude its children.

transformAttributes is set to false

Returns:

transformed JDOM XML document

Throws:

MXApplicationException

transformFromMaximoFormat

public static org.jdom.Document transformFromMaximoFormat(org.jdom.Document inDoc,
                                                          java.lang.String outFormat,
                                                          java.util.Set<java.lang.String> exclusionsSet,
                                                          boolean transformAttributes)
                                                   throws MXApplicationException

Transform the input org.jdom.Document using the Maximo Bidi layout format to output Bidi layout format (inbound). Formats are supplied into Bidi FlagSet format. See BidiFlags

Parameters:

inDoc - Input XML document. If null, IllegalArgumentException will be thrown.

outFormat - Output Bidi flag-set format parameters

exclusionsSet - the list of unique text entries those shouldn't be processed by the Bidi transformer. Exclusion for a node doesn't exclude its children.

transformAttributes - decides whether to transform the values of element's attributes or not

Returns:

transformed JDOM XML document

Throws:

MXApplicationException