com.teraspaces.qwfix
Class FIXSchema

java.lang.Object
  extended by com.teraspaces.qwfix.FIXObject
      extended by com.teraspaces.qwfix.FIXSchema

public final class FIXSchema
extends FIXObject

Represents the schema of FIX communication protocol. This class cannot be inherited.


Field Summary
 
Fields inherited from class com.teraspaces.qwfix.FIXObject
DOCUMENT_TYPE_FAST_SCHEMA, DOCUMENT_TYPE_FIX_ENGINE, DOCUMENT_TYPE_FIX_SCHEMA, DOCUMENT_TYPE_PROCESS, DOCUMENT_TYPE_SCHEDULER, DOCUMENT_TYPE_SESSION, DOCUMENT_TYPE_VISUAL_LAMBDA
 
Constructor Summary
FIXSchema(FIXSchema parent, FIXVersion fixVersion, QWVersion version, String name, String description)
          Instantiates a new fIX schema.
FIXSchema(FIXSchema parent, FIXVersion fixVersion, String name, String description)
          Instantiates a new fIX schema.
 
Method Summary
static FIXSchema fromXmlDocument(Document doc, FIXSchemaLoader loader)
          Deserializes from an XML document.
 String getApplExtID()
          Gets the ApplVerID.
 String getApplVerID()
          Gets the ApplVerID.
 FIXSchemaComponentCollection getComponents()
          Gets the components.
 String getCstmApplVerID()
          Gets the CstmApplVerID.
 String getDescription()
          Gets the description.
 FIXSchemaFieldCollection getFields()
          Gets the list of fields.
 FIXVersion getFIXVersion()
          Gets the fIX version.
 FIXSchemaHeader getHeader()
          Gets the header.
 FIXSchemaMessageCollection getMessages()
          Gets the messages.
 String getName()
          Gets the name.
 FIXSchema getParent()
          Gets the parent schema.
 String getParentName()
          Gets the parent schema name.
 Version getParentVersion()
          Gets the parent schema version.
 FIXSchemaTrailer getTrailer()
          Gets the trailer.
 FIXSchema getTransportSchema()
          Gets the transport schema.
 QWVersion getVersion()
          Gets the version.
 boolean isTransportSchema()
          Gets a value indicating whether this instance is a transport schema.
 
Methods inherited from class com.teraspaces.qwfix.FIXObject
createXmlDocument, getGuid, parseXmlDocument, readXmlDocumentInfo, writeXmlDocumentInfo
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FIXSchema

public FIXSchema(FIXSchema parent,
                 FIXVersion fixVersion,
                 QWVersion version,
                 String name,
                 String description)
Instantiates a new fIX schema.

Parameters:
parent - the parent schema
fixVersion - the FIX version
version - the QWFIX schema version
name - the name
description - the description

FIXSchema

public FIXSchema(FIXSchema parent,
                 FIXVersion fixVersion,
                 String name,
                 String description)
Instantiates a new fIX schema.

Parameters:
parent - the parent schema
fixVersion - the FIX version
name - the schema name
description - the description
Method Detail

getName

public String getName()
Gets the name.

Returns:
the name

getDescription

public String getDescription()
Gets the description.

Returns:
the description

getVersion

public QWVersion getVersion()
Gets the version.

Returns:
the version

isTransportSchema

public boolean isTransportSchema()
Gets a value indicating whether this instance is a transport schema.

Returns:
true if this instance is a transport schema; otherwise, false

getTransportSchema

public FIXSchema getTransportSchema()
Gets the transport schema.

Returns:
the transport schema

getFields

public FIXSchemaFieldCollection getFields()
Gets the list of fields. The returned list is read only.

Returns:
the fields

getComponents

public FIXSchemaComponentCollection getComponents()
Gets the components. The returned list is read only.

Returns:
the components

getMessages

public FIXSchemaMessageCollection getMessages()
Gets the messages. The returned list is read only.

Returns:
the messages

getApplVerID

public String getApplVerID()
Gets the ApplVerID.

Returns:
the ApplVerID

getApplExtID

public String getApplExtID()
Gets the ApplVerID.

Returns:
the ApplVerID

getCstmApplVerID

public String getCstmApplVerID()
Gets the CstmApplVerID.

Returns:
the CstmApplVerID

getFIXVersion

public FIXVersion getFIXVersion()
Gets the fIX version.

Returns:
the fIX version

getParent

public FIXSchema getParent()
Gets the parent schema.

Returns:
the parent schema

getHeader

public FIXSchemaHeader getHeader()
Gets the header.

Returns:
the header

getTrailer

public FIXSchemaTrailer getTrailer()
Gets the trailer.

Returns:
the trailer

getParentName

public String getParentName()
Gets the parent schema name.

Returns:
the parent schema name

getParentVersion

public Version getParentVersion()
Gets the parent schema version.

Returns:
the parent schema version

fromXmlDocument

public static FIXSchema fromXmlDocument(Document doc,
                                        FIXSchemaLoader loader)
Deserializes from an XML document.

Parameters:
doc - the XML document
loader - the loader
Returns:
the fIX schema