com.tailf.maapi

Class MaapiSchemas.CSSchema

Object

com.tailf.maapi.MaapiSchemas.CSSchema

Enclosing class:

MaapiSchemas

public class MaapiSchemas.CSSchema
extends Object

The Schema Container class. Contains the first root node, if available, of the schema as well as other information about the schema and its named types. It is instances of this class that is retrieved using method findSchema see MaapiSchemas.findCSSchema(int) and MaapiSchemas.findCSSchema(String)

Constructor Summary

Constructors

Constructor and Description
CSSchema() Constructor for CSSchema

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getModule() Get module name
Hashtable<String,MaapiSchemas.CSNamedType>	getNamedTypes() Get a Hashtable of all named types, the Hashtable has the type names as keys represented as strings and the types as values represented as CSType objects.
String	getNS() Get Namespace string.
int	getNSHash() Get Namespace hashvalue
String	getPrefix() Get Namespace prefix string
String	getRevision() Get schema revision
MaapiSchemas.CSNode	getRootNode() Get first Schema root node.
String	getURI() Get Schema uri string
int	hashCode()
boolean	isDynamic() Check if Schema is dynamically lalala
String	toString() Informative string representation of a CSSchema instance

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CSSchema

public CSSchema()

Constructor for CSSchema

Method Detail

getNSHash

public int getNSHash()

Get Namespace hashvalue

Returns:

int hashvalue

getNS

public String getNS()

Get Namespace string. Usually it is unique string that defines the namespace . (for example: "http://acme.example.com/system")

Returns:

String Namespace string

getURI

public String getURI()

Get Schema uri string

Returns:

String Schema uri string

getPrefix

public String getPrefix()

Get Namespace prefix string

Returns:

String Namespace prefix string

getRevision

public String getRevision()

Get schema revision

Returns:

String revision

getModule

public String getModule()

Get module name

Returns:

String module

getRootNode

public MaapiSchemas.CSNode getRootNode()

Get first Schema root node. Note, that a Schema can have several nodes on root level in parallel, this method retrieves the first root node. Also, a schema does not necessarily have any root node then this method returns null.

Returns:

CSNode the first root node or null if no root node exists

getNamedTypes

public Hashtable<String,MaapiSchemas.CSNamedType> getNamedTypes()

Get a Hashtable of all named types, the Hashtable has the type names as keys represented as strings and the types as values represented as CSType objects.

Returns:

Hashtable of named types

isDynamic

public boolean isDynamic()

Check if Schema is dynamically lalala

Returns:

boolean true if dynamically lalala

toString

public String toString()

Informative string representation of a CSSchema instance

Overrides:

toString in class Object

Returns:

String

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object