com.prowidesoftware.swift.model.mx

Class AbstractMX

java.lang.Object

com.prowidesoftware.swift.model.mx.AbstractMX

All Implemented Interfaces:

IDocument

public abstract class AbstractMX
extends Object
implements IDocument

Base class for specific MX.
Notice, the scope of Prowide MX model is the message payload (the actual message or body data) which is the fundamental purpose of the transmission. The transmission wrappers (overhead data) are excluded and intentionally ignored if found.
Subclasses implement the Document portion of each specific message.

Since:

7.6

Author:

www.prowidesoftware.com

See Also:

AbstractMT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMX()
protected	AbstractMX(BusinessHeader businessHeader)

Method Summary

Methods

Modifier and Type	Method and Description
BusinessHeader	getBusinessHeader()
abstract String	getBusinessProcess() get the Alphabetic code in four positions (fixed length) identifying the Business Process
abstract Class[]	getClasses() Get the classes associated with this message
abstract int	getFunctionality() Get the code identifying the Message Functionality
MxId	getMxId() Returns the MX message identification. Composed by the business process, functionality, variant and version.
abstract String	getNamespace() Get the XML namespace of the message
abstract int	getVariant() Get the Message variant
abstract int	getVersion() Get the message version
abstract String	message() Get this message as an XML string
protected static String	message(String namespace, AbstractMX obj, Class[] classes)
protected static AbstractMX	read(Class<? extends AbstractMX> targetClass, String xml, Class[] classes)
protected void	setBusinessHeader(BusinessHeader businessHeader)
void	write(File file) Writes the message into a file with its message content in the FIN format.
void	write(OutputStream stream) Writes the message into a given output stream with its message content in the FIN format, encoding content in UTF-8.
Source	xmlSource() Convenience method to get this message XML as javax.xml.transform.Source

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMX

protected AbstractMX()

AbstractMX

protected AbstractMX(BusinessHeader businessHeader)

Method Detail

message

protected static String message(String namespace,
             AbstractMX obj,
             Class[] classes)

read

protected static AbstractMX read(Class<? extends AbstractMX> targetClass,
              String xml,
              Class[] classes)

getClasses

public abstract Class[] getClasses()

Get the classes associated with this message

Since:

7.7

getNamespace

public abstract String getNamespace()

Get the XML namespace of the message

Since:

7.7

getBusinessProcess

public abstract String getBusinessProcess()

get the Alphabetic code in four positions (fixed length) identifying the Business Process

Returns:

the business process of the implementing class

Since:

7.7

getFunctionality

public abstract int getFunctionality()

Get the code identifying the Message Functionality

Returns:

Since:

7.7

getVariant

public abstract int getVariant()

Get the Message variant

Returns:

Since:

7.7

getVersion

public abstract int getVersion()

Get the message version

Returns:

Since:

7.7

message

public abstract String message()

Get this message as an XML string

Returns:

Since:

7.7

xmlSource

public Source xmlSource()

Convenience method to get this message XML as javax.xml.transform.Source

Returns:

null if message() returns null or StreamSource in other case

Since:

7.7

See Also:

message()

write

public void write(File file)
           throws IOException

Writes the message into a file with its message content in the FIN format.

Parameters:

a - non null file to write, if it does not exists, it will be created

Throws:

IOException

Since:

7.7

write

public void write(OutputStream stream)
           throws IOException

Writes the message into a given output stream with its message content in the FIN format, encoding content in UTF-8.

Parameters:

a - non null stream to write

Throws:

IOException

Since:

7.7

getBusinessHeader

public BusinessHeader getBusinessHeader()

Returns:

the business header or null if not set

Since:

7.7

setBusinessHeader

protected void setBusinessHeader(BusinessHeader businessHeader)

Parameters:

businessHeader - the header to set

Since:

7.7

getMxId

public MxId getMxId()

Returns the MX message identification.
Composed by the business process, functionality, variant and version.

Returns:

the constructed message id

Since:

7.7