OFXAggregate Class

Properties   Methods   Events   Config Settings   Errors  

The OFXAggregate class supports parsing of XML aggregates that can be retrieved from other classes.

Syntax

inebank.OFXAggregate

Remarks

The OFXAggregate class supports simple XML aggregate traversal functionality. Simply set the Aggregate property to the value received from any aggregate property of any class in the package (e.g. the TxAggregate property from BankStatement or CCStatement). You can then use XPath to walk the Document Object Model (DOM) tree.

Property List

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

AggregateThe full text of the current aggregate.
NamespacesThis property includes a collection of namespaces in the current namespace stack.
XChildrenThis property includes a collection of child elements of the currently selected XML element.
XElementThis property includes the name of the current element.
XNamespaceThis property includes the namespace of the current element.
XParentThis property includes the parent of the current element.
XPathThis property provides a way to point to a specific element in the document.
XPrefixThis property includes the prefix of the current element.
XTextThis property includes the text of the current element.

Method List

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

ConfigSets or retrieves a configuration setting.
HasXPathChecks whether a certain XPath exists inside the aggregate.

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.

ErrorFired when information is available about errors during data delivery.

Config Settings

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

CacheContentIf true, the original XML is saved in a buffer.
CharsetSpecifies the charset used when encoding data.
CloseInputStreamAfterProcessDetermines whether or not the input stream is closed after processing.
CloseOutputStreamAfterProcessDetermines whether or not the output stream is closed after processing.
EOLThe characters to use for separating lines.
ErrorOnEmptyAttrIf true, passing an invalid attribute to the Attr method will throw an exception.
ExtraNameCharsExtra characters for the parser to consider as name characters.
ExtraSpaceCharsExtra characters for the parser to consider as white space.
FlushOnEOLIf set, the parser flushes its text buffer after every line of text.
IgnoreBadAttributePrefixesIf true, bad (unknown) attribute prefixes are ignored.
IgnoreBadElementPrefixesIf true, bad (unknown) element prefixes are ignored.
IncludeElementPrefixWhether to include the prefix in the element name.
IncludeXMLDeclarationWhether to include the XML declaration when writing XML.
IndentThe characters to use for each indentation level.
InterruptWhether to stop parsing the current XML document.
OffsetCurrent offset of the document being parsed.
PreserveWhitespaceIf true, leading and trailing whitespace in element text is preserved.
QuoteCharQuote character to use for attribute values.
StringProcessingOptionsDefines options to use when processing string values.
BuildInfoInformation about the product's build.
GUIAvailableWhether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
UseDaemonThreadsWhether threads created by the class are daemon threads.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

Aggregate Property (OFXAggregate Class)

The full text of the current aggregate.

Syntax

public String getAggregate();
public void setAggregate(String aggregate);

Default Value

""

Remarks

Aggregate contains the full text of the XML aggregate currently being represented by the class's DOM. You may set this to a value obtained from any aggregate property of any other control (such as SignOnInfoAggregate from FIProfile). Once set, you can use XPath to walk the DOM tree. XElement and XText will retrieve the current element's name and contents, and XChildren can be used to get the number of children.

Namespaces Property (OFXAggregate Class)

This property includes a collection of namespaces in the current namespace stack.

Syntax

public XMLNamespaceList getNamespaces();
public void setNamespaces(XMLNamespaceList namespaces);

Remarks

This property contains a collection of XML namespaces, which are standards for providing uniquely named elements and attributes in an XML instance.

This collection is indexed from 0 to size -1.

This property is not available at design time.

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

XChildren Property (OFXAggregate Class)

This property includes a collection of child elements of the currently selected XML element.

Syntax

public XMLElementList getXChildren();
public void setXChildren(XMLElementList XChildren);

Remarks

This property contains a collection of child elements of the currently selected XML element. The elements are provided in the collection in the same order they are found in the XML document.

This collection is indexed from 0 to size -1.

This property is not available at design time.

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

XElement Property (OFXAggregate Class)

This property includes the name of the current element.

Syntax

public String getXElement();
public void setXElement(String XElement);

Default Value

""

Remarks

The current element is specified through the XPath property.

XNamespace Property (OFXAggregate Class)

This property includes the namespace of the current element.

Syntax

public String getXNamespace();
public void setXNamespace(String XNamespace);

Default Value

""

Remarks

The current element is specified through the XPath property.

XParent Property (OFXAggregate Class)

This property includes the parent of the current element.

Syntax

public String getXParent();

Default Value

""

Remarks

The current element is specified through the XPath property.

This property is read-only.

XPath Property (OFXAggregate Class)

This property provides a way to point to a specific element in the document.

Syntax

public String getXPath();
public void setXPath(String XPath);

Default Value

""

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

'name'A particular element name
name[i]The i-th subelement of the current element with the given name
[i]The i-th subelement of the current element
[last()]The last subelement of the current element
[last()-i]The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]The subelement containing a particular value for a given attribute (supports single AND double quotes)
..The parent of the current element
When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, XChildren , and XText providing other properties of the element. The attributes of the current element are provided in the XAttributes collection.

BuildDOM must be set to True before parsing the document for the XPath functionality to be available.

Example. Setting XPath:

Document rootXML.XPath = "/"
Specific ElementXML.XPath = "/root/SubElement1/SubElement2/"
i-th ChildXML.XPath = "/root/SubElement1[i]"

XPrefix Property (OFXAggregate Class)

This property includes the prefix of the current element.

Syntax

public String getXPrefix();
public void setXPrefix(String XPrefix);

Default Value

""

Remarks

The current element is specified through the XPath property.

XText Property (OFXAggregate Class)

This property includes the text of the current element.

Syntax

public String getXText();
public void setXText(String XText);

Default Value

""

Remarks

The current element is specified through the XPath property.

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

HasXPath Method (OFXAggregate Class)

Checks whether a certain XPath exists inside the aggregate.

Syntax

public boolean hasXPath(String XPath);

Remarks

Used when there is no assurance that a certain XPath exists inside an aggregate.

Error Event (OFXAggregate Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultOFXAggregateEventListener implements OFXAggregateEventListener {
  ...
  public void error(OFXAggregateErrorEvent e) {}
  ...
}

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

XMLElement Type

This type describes an element contained within the XML document.

Remarks

This type describes an XML element. The fields for this type describe the element Name, Prefix, and Namespace of the given element.

The elements are inserted into the array in the same order they are found in the document.

The following fields are available:

Fields

Name
String (read-only)
Default Value: ""

The Name field provides the local name (without a prefix) of the element.

Namespace
String (read-only)
Default Value: ""

This field contains the namespace of the element.

Prefix
String (read-only)
Default Value: ""

This field contains the prefix of the element (if any). If the element does not have a prefix, this property is empty.

XText
String (read-only)
Default Value: ""

This field contains the inner text of the element.

Constructors

public XMLElement();

XMLNamespace Type

This type describes an XML namespace from the current namespace stack.

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the Prefix and the URI of the namespace being defined.

The default namespace exists at index 0. The Prefix field at index 0 is xmlns, and the Name field contains the default namespace.

The following fields are available:

Fields

Prefix
String
Default Value: ""

This field contains the Prefix for the Namespace.

URI
String
Default Value: ""

This field contains the namespace URI associated with the corresponding Prefix. This URL is usually pointing to the XML schema for the namespace.

Constructors

public XMLNamespace();

public XMLNamespace( URI,  prefix);

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

XML Config Settings

CacheContent:   If true, the original XML is saved in a buffer.

This configuration setting controls whether or not the component retains the entire original XML in a buffer. This is used to retain the original XML as opposed to returning generated XML after parsing. The default value is True.

Charset:   Specifies the charset used when encoding data.

This configuration setting specifies the character set used when encoding data. This value will also be used when creating the XMLDeclaration. The default value is "utf-8".

CloseInputStreamAfterProcess:   Determines whether or not the input stream is closed after processing.

This configuration setting determines whether or not the input stream set by SetInputStream is closed after processing is complete. The default value is True.

CloseOutputStreamAfterProcess:   Determines whether or not the output stream is closed after processing.

This configuration setting determines whether or not the output stream set by SetOutputStream is closed after processing is complete. The default value is True.

EOL:   The characters to use for separating lines.

If specified, the class will format the output XML, using the specified characters to separate multiple lines for nested XML elements. The default value is CRLF ("\r\n") .

This option should be combined with Indent for full effect.

ErrorOnEmptyAttr:   If true, passing an invalid attribute to the Attr method will throw an exception.

If an invalid attribute name is passed into the GetAttr method, the method will return with an empty string if this is set to False; otherwise, an exception is thrown.

ExtraNameChars:   Extra characters for the parser to consider as name characters.

Normally, the parser considers only the following characters as part of an XML identifier: 'A' through 'Z', 'a' through 'z', '0' through '9', 0x0300 through 0x036F, 0x203F through 0x2040, and '.', '-', '_', ':'.

If you would like any other characters to be considered as name characters, you may set them as a string into this property.

ExtraSpaceChars:   Extra characters for the parser to consider as white space.

Normally, the parser considers only the following characters as white space: ' ' (space), '\t' (tab), '\ n' (newline), '\r' (carriage return), '\f' (form feed), and '\v' (vertical tab).

If you would like any other characters to be considered as white space, you may set them as a string into this property.

FlushOnEOL:   If set, the parser flushes its text buffer after every line of text.

The FlushOnEOL property controls whether or not Characters events are fired for every line of the input text stream. Normally, lines are buffered internally and delivered in batches, but if the FlushOnEOL flag is set, then a Characters event is fired for each line.

IgnoreBadAttributePrefixes:   If true, bad (unknown) attribute prefixes are ignored.

Normally a trappable error is generated when an unknown attribute prefix is encountered. This configuration setting suppresses the error. The default value is True.

IgnoreBadElementPrefixes:   If true, bad (unknown) element prefixes are ignored.

Normally a trappable error is generated when an unknown element prefix is encountered. This configuration setting suppresses the error. The default value is True.

IncludeElementPrefix:   Whether to include the prefix in the element name.

This configuration setting specifies whether or not to include the element prefix in the Element parameter of the StartElement and EndElement events.

If False (default) and Validate is set to False, the prefix is included in the Element parameter (e.g., ds:DigestMethod).

If True and Validate is set to False, the prefix is not included in the Element parameter (e.g., DigestMethod).

This setting is applicable only when Validate is False.

IncludeXMLDeclaration:   Whether to include the XML declaration when writing XML.

This configuration setting specifies whether the XML declaration is included in the output XML when writing XML. When set to True (default), the XML declaration will be included above any user-specified XML. For instance: 

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...
Indent:   The characters to use for each indentation level.

If specified, the class will format the output XML, using the specified characters to denote each indentation level for nested XML elements.

This option should be combined with EOL for full effect.

Interrupt:   Whether to stop parsing the current XML document.

This configuration setting can be called from within any event to stop further parsing of the document. The configuration setting only works from within events. For example: void xml_OnStartElement(object sender, XMLStartElementEventArgs e) { xml.Config("Interrupt"); }

Offset:   Current offset of the document being parsed.

This property is useful for determining the location of possible XML errors in the document.

Offset values start at 1.

PreserveWhitespace:   If true, leading and trailing whitespace in element text is preserved.

Normally, the leading and trailing whitespace from an element's text is trimmed. When this property is set to True, this leading and trailing whitespace is preserved. The default value is False.

QuoteChar:   Quote character to use for attribute values.

By default, the class will use double quotes around attribute values. This property can be used to specify a different character, such as a single quote.

StringProcessingOptions:   Defines options to use when processing string values.

This configuration setting determines what additional processing is performed on string values fired through the Characters event.

Note: This applies only when BuildDOM is False.

By default, no additional processing is performed and the string is returned as is from the document. Strings may also be XML unescaped. Possible values are as follows:

0 (none - default) No additional processing is performed.
1 Strings are XML unescaped.

For instance, when set to 0, the following text may be fired through the Characters event:

&amp;&quot;&lt;&gt;

When set to 1, the following text would be fired through the Characters event:

&"<>

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitiveData:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseDaemonThreads:   Whether threads created by the class are daemon threads.

If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

Trappable Errors (OFXAggregate Class)

XML Errors

101   Invalid attribute index.
102   No attributes available.
103   Invalid namespace index.
104   No namespaces available.
105   Invalid element index.
106   No elements available.
107   Attribute does not exist.
201   Unbalanced element tag.
202   Unknown element prefix (cannot find namespace).
203   Unknown attribute prefix (cannot find namespace).
204   Invalid XML markup.
205   Invalid end state for parser.
206   Document contains unbalanced elements.
207   Invalid XPath.
208   No such child.
209   Top element does not match start of path.
210   DOM tree unavailable (set BuildDOM to True and reparse).
302   Cannot open file.
401   Invalid XML would be generated.
402   An invalid XML name has been specified.