CargoValidator Class

Properties   Methods   Events   Config Settings   Errors  

CargoValidator is a lightweight Cargo-IMP validation class designed for simple document validation.

Syntax

ipworkseditranslator.Cargovalidator

Remarks

This component provides a simple way to validate a Cargo-IMP and obtain details about any validation errors.

Cargo-IMP Validation

Before calling Validate call LoadSchema to load the schema for the message to be validated. The validation performed by the class depends largely on the schema's definition.

When the Validate method is called the class will attempt to validate the message. After the message has been validated the ValidationErrors property will be populated with details of each error.

Inspect the ValidationErrors property for information on any errors that were encountered.

Validation Example validator.InputFile = "files/CargoMessages/Message.txt"; validator.LoadSchema("my_schemas/cargoimp_schemas/FWB.json"); validator.Validate(); foreach (CargoError error in validator.ValidationErrors) { Console.WriteLine(error.Description); }

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.

InputData Property (CargoValidator Class)

The data to validate.

Syntax

public String getInputData();


public void setInputData(String inputData);

Default Value

""

Remarks

This property specifies the data to be validated.

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 (CargoValidator Class)

The file to validate.

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.

ValidationErrors Property (CargoValidator Class)

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

Syntax

public CargoErrorList getValidationErrors();

Remarks

This property is populated with error information. There may be one or more errors.

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

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

Config Method (Cargovalidator 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 (Cargovalidator 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.

Reset Method (Cargovalidator Class)

Resets the class.

Syntax

public void reset();

Remarks

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

SetInputStream Method (Cargovalidator Class)

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

Syntax

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

Remarks

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

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.

Validate Method (Cargovalidator Class)

Validate the specified input data.

Syntax

public void validate();

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.

Error Event (Cargovalidator Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultCargovalidatorEventListener implements CargovalidatorEventListener {
  ...
  public void error(CargovalidatorErrorEvent e) {}
  ...
}

public class CargovalidatorErrorEvent {
  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.

The ErrorCode parameter contains an error code, and the Description parameter 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 (Cargovalidator Class)

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

Syntax

public class DefaultCargovalidatorEventListener implements CargovalidatorEventListener {
  ...
  public void resolveSchema(CargovalidatorResolveSchemaEvent e) {}
  ...
}

public class CargovalidatorResolveSchemaEvent {
  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

Config Settings (Cargovalidator 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.

Base Config Settings

Trappable Errors (Cargovalidator Class)

CargoValidator 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.