CargoReader Class

Properties   Methods   Events   Config Settings   Errors  

The CargoReader class is optimized for Cargo-IMP documents, providing a simple way to parse Cargo-IMP documents.

Syntax

ipworkseditranslator.Cargoreader

Remarks

The class allows you to parse a Cargo-IMP message. Below are example steps:

1. First, use LoadSchema to load a schema file into the class. (Only necessary when preserving document structure).
2. Open a Cargo-IMP message or stream by setting input via SetInputStream, InputFile or InputData.
3. Call the Parse method to parse the message.
4. When parsing is complete, you can retrieve the parsed values from the Values collection.

During parsing, the class performs basic validation of the incoming document. If validation fails, a warning is generated (fired as an event).

Schemas are written in JSON format: { "name": "FSU", "desc": "FSU MESSAGE", "children": { "1": { "desc": "Standard Message Identification", "children": { "1.1": { "desc": "Standard Message Identifier", "value": "FSU" }, "1.2": { "value": "/" }, "1.3": { "desc": "Message Type Version Number", "format": "n[...3]" }, "1.4": { "value": "\r\n" } } }, "2": { ... For example schemas and questions, please contact support@nsoftware.com.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Errors Property (CargoReader Class)

A collection of errors that occurred when parsing the Cargo-IMP messages.

Syntax

public CargoErrorList getErrors();

Remarks

This property is populated with error information. After calling Parse, check this property to determine if any errors occurred while parsing the message. If there are any errors present, the Values collection will likely be incorrect.

This property is read-only and not available at design time.

Please refer to the CargoError type for a complete list of fields.

InputData Property (CargoReader Class)

The data to parse.

Syntax

public String getInputData();


public void setInputData(String inputData);

Default Value

""

Remarks

This property specifies the data to be parsed.

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputData

When a valid source is found the search stops.

InputFile Property (CargoReader Class)

The file to parse.

Syntax

public String getInputFile();


public void setInputFile(String inputFile);

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputData

When a valid source is found the search stops.

This property is not available at design time.

Values Property (CargoReader Class)

Collection of values after parsing the Cargo-Imp messages.

Syntax

public CargoValueList getValues();

Remarks

This property will be populated with the values from the Cargo-IMP message after parsing is complete.

This property is read-only and not available at design time.

Please refer to the CargoValue type for a complete list of fields.

Config Method (Cargoreader Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

LoadSchema Method (Cargoreader Class)

Loads a schema file describing a Message type.

Syntax

public void loadSchema(String fileName);

Remarks

This method parses the File and loads it into an internal schema list.

If the schema file does not exist or cannot be parsed as an Cargo-IMP schema, the class throws an exception.

Schemas are written in JSON format: { "name": "FSU", "desc": "FSU MESSAGE", "children": { "1": { "desc": "Standard Message Identification", "children": { "1.1": { "desc": "Standard Message Identifier", "value": "FSU" }, "1.2": { "value": "/" }, "1.3": { "desc": "Message Type Version Number", "format": "n[...3]" }, "1.4": { "value": "\r\n" } } }, "2": { ... For example schemas and questions, please contact support@nsoftware.com.

Parse Method (Cargoreader Class)

Parse the specified input data.

Syntax

public void parse();

Remarks

This method parses the input data specified by SetOutputStream, InputFile or InputData.

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputData

When a valid source is found the search stops.

Reset Method (Cargoreader Class)

Resets the class.

Syntax

public void reset();

Remarks

When called, the class initializes itself to its default state.

SetInputStream Method (Cargoreader Class)

Sets the stream from which the class will read the data to parse.

Syntax

public void setInputStream(java.io.InputStream inputStream);

Remarks

This method sets the stream from which the class will read the data to parse.

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputData

When a valid source is found the search stops.

Error Event (Cargoreader Class)

Information about errors during data delivery.

Syntax

public class DefaultCargoreaderEventListener implements CargoreaderEventListener {
  ...
  public void error(CargoreaderErrorEvent e) {}
  ...
}

public class CargoreaderErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ResolveSchema Event (Cargoreader Class)

Fires whenever a new Cargo-Imp message is encountered and no schema is found for it.

Syntax

public class DefaultCargoreaderEventListener implements CargoreaderEventListener {
  ...
  public void resolveSchema(CargoreaderResolveSchemaEvent e) {}
  ...
}

public class CargoreaderResolveSchemaEvent {
  public String messageIdentifier;
  public String version;
}

Remarks

The ResolveSchema event will fire when a the class encounters a new Cargo-IMP message, but it finds no schema corresponding to it already loaded.

MessageIdentifier contains the message type, such as "FWB" or "FSU".

Version contains the version of the schema used by the message.

When processing this event, the caller can use LoadSchema() to load a new schema into the class that can be used to parse the transaction.

CargoError Type

This type contains the details of an error that occurred while parsing a Cargo-IMP message.

Remarks

The fields below provide information about the error.

Fields

CargoValue Type

A value parsed from a Cargo-Imp message.

Remarks

The fields below provide information about the value.

Fields

Config Settings (Cargoreader Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

CARGOREADER Config Settings

Base Config Settings

Trappable Errors (Cargoreader Class)

CargoReader Errors

	1000   Invalid schema file.
	1001   No schema found.
	1002   Schema format error.
	1003   Line or message was too long.
	1004   Failed to parse the message version.
	1005   Element is not in the schema file or is not a simple element.
	1006   Could not find the element.