org.sdmxsource.sdmx.ediparser.util

Class EDIUtil

java.lang.Object

org.sdmxsource.sdmx.ediparser.util.EDIUtil

public class EDIUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
EDIUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	assertPrefix(EDIReader dataReader, EDI_PREFIX prefix, boolean errorOnFail) Checks the prefix is as expected If the prefix is not as expected an exception will be thrown
static java.lang.String	ediToString(java.lang.String inputStr) Takes an EDI String, removes all EDI escape characters
static java.lang.String	getSiblingGroupId()
static boolean	isTruncateLongValues()
static void	parseId(java.lang.String id) Ensures that the supplied id does not contain invalid characters.
static int	parseStringAsInt(java.lang.String str)
static void	setSiblingGroupId(java.lang.String siblingGroupId)
static void	setTruncateLongValues(boolean newValue) Setting this to true, requests that the EDI Data Writer truncate and round any observation value longer than 15 characters.
static java.lang.String[]	splitOnColon(java.lang.String str)
static java.lang.String[]	splitOnColon(java.lang.String str, int expectedNumbersplits)
static java.lang.String[]	splitOnPlus(java.lang.String str)
static java.lang.String[]	splitOnPlus(java.lang.String str, int expectedNumbersplits)
static java.lang.String	stringToEdi(java.lang.String inputStr) Takes a string literal and converts it to an EDI valid string with escape characters
static java.lang.String	stringToEDIFreeText(java.lang.String str, int segmentLength, int maxLength) Takes a string literal and converts it to an EDI valid string.
static java.util.List<java.lang.String>	stringToEDIFreeText(java.lang.String str, int segmentLength, int lineLength, int maxRows) Takes a string literal and converts it to an EDI valid list of Strings.
static java.lang.String	stringToEDIWithMaxLength(java.lang.String inputStr, int maxAllowedLength) Takes a string literal and converts it to an EDI valid string with escape characters but it may truncate the string if it goes beyond the specified maximum length.
static java.lang.String	truncate(java.lang.String aStr) Given a string, truncates it by rounding the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

EDIUtil

public EDIUtil()

Method Detail

parseStringAsInt

public static int parseStringAsInt(java.lang.String str)

stringToEdi

public static java.lang.String stringToEdi(java.lang.String inputStr)

Takes a string literal and converts it to an EDI valid string with escape characters

Parameters:

inputStr -

Returns:

stringToEDIWithMaxLength

public static java.lang.String stringToEDIWithMaxLength(java.lang.String inputStr,
                                        int maxAllowedLength)

Takes a string literal and converts it to an EDI valid string with escape characters but it may truncate the string if it goes beyond the specified maximum length. Note that the produced String may have a specified length greater than that specified if the inputString has EDI escape characters (Release Characters). e.g. Converting the 16 character string: 012+'?6789012345 to 10 characters would result in a 13 character string being produced (012?+?'??6789).

Parameters:

aStr - The non-EDI string

maxAllowedLength - The maximum string length, but based on the original string. Only specifying a positive integers will have any effect.

Returns:

ediToString

public static java.lang.String ediToString(java.lang.String inputStr)

Takes an EDI String, removes all EDI escape characters

Parameters:

inputStr -

Returns:

stringToEDIFreeText

public static java.lang.String stringToEDIFreeText(java.lang.String str,
                                   int segmentLength,
                                   int maxLength)

Takes a string literal and converts it to an EDI valid string. This involves:

• Adding the EDI Free Text prefix.
• Inserting escape characters.
• Inserting colons every maxLength number of characters.
• Adding the EDI end of line character to the end of the input string.

Parameters:

str - The string to convert

maxLength - The maximum permissible length of the String

Returns:

The String in EDI format

stringToEDIFreeText

public static java.util.List<java.lang.String> stringToEDIFreeText(java.lang.String str,
                                                   int segmentLength,
                                                   int lineLength,
                                                   int maxRows)

Takes a string literal and converts it to an EDI valid list of Strings. This involves:

• Adding the EDI Free Text prefix to each returned String element.
• Inserting escape characters.
• Inserting colons at the end of each line
• Adding the EDI end of line character to the end of each returned String element.

Parameters:

str - The string to convert

segmentLength - The maximum length before a segment is inserted into the String

lineLength - The maximum permissible length of a single line

maxRows - The maximum number of rows allowed

Returns:

The String in EDI format

parseId

public static void parseId(java.lang.String id)

Ensures that the supplied id does not contain invalid characters. Allowed characters are A-Z 0-9 and _ and the length of the id must not be beyond 18 characters.

Parameters:

id - The id to check

Throws:

java.lang.IllegalArgumentException - if the specified id is deemed to be invalid

splitOnPlus

public static java.lang.String[] splitOnPlus(java.lang.String str)

splitOnPlus

public static java.lang.String[] splitOnPlus(java.lang.String str,
                             int expectedNumbersplits)

splitOnColon

public static java.lang.String[] splitOnColon(java.lang.String str)

splitOnColon

public static java.lang.String[] splitOnColon(java.lang.String str,
                              int expectedNumbersplits)

assertPrefix

public static boolean assertPrefix(EDIReader dataReader,
                   EDI_PREFIX prefix,
                   boolean errorOnFail)

Checks the prefix is as expected

If the prefix is not as expected an exception will be thrown

Parameters:

prefix -

truncate

public static java.lang.String truncate(java.lang.String aStr)

Given a string, truncates it by rounding the value.

Parameters:

obsValue - The String representing the observation value

Returns:

The rounded value in String form.

getSiblingGroupId

public static java.lang.String getSiblingGroupId()

setSiblingGroupId

public static void setSiblingGroupId(java.lang.String siblingGroupId)

isTruncateLongValues

public static boolean isTruncateLongValues()

setTruncateLongValues

public static void setTruncateLongValues(boolean newValue)

Setting this to true, requests that the EDI Data Writer truncate and round any observation value longer than 15 characters.