SASchemaClass Class Reference

This class is the base class for Studio Assist schema generators that are based on XML-enabled class definitions. More...

Inheritance diagram for SASchemaClass:

Collaboration diagram for SASchemaClass:

Static Public Member Functions
_.Library.Status	GetAttrsForClass (_.Library.String pClass, pAttrList)
	Given a class (and default namespace) find the list of XML attributes. More...
_.Library.Status	GetElementsForClass (_.Library.String pClass, pElementList, pReferencedClasses)
	Given a class (and default namespace) find the list of XML elements. More...
_.Library.Status	GetXMLElementsForClass (_.Library.String pClass, pElements)
	Return an array of XML element names that could be used within a. More...
_.Library.String	GetXMLNameForClass (_.Library.String pClass)
	Return the XML name for the given class (or "" if there is none). More...
_.Library.Boolean	IsUpToDate (_.Library.String pChecksum, _.Library.String pParameter)
	Subclass should override this method. More...
_.Library.Status	OutputToStream (_.Stream.Object pStream, _.Library.String pChecksum, _.Library.String pParameter)
	Output SASchema definition into a stream.
_.Library.String	SchemaToPrefix (_.Library.String pSchema)
	Convert a schema name to a reasonable "prefix".
_.Library.String	XMLName2DisplayName (_.Library.String pName, _.Library.String pCurrentNS)
	Take an element and make sure it has the correct namespace prefix. More...
Static Public Member Functions inherited from SASchema
_.Library.Status	OutputToFile (pFilename)
	Output the SASchema definition to a file. More...

Static Public Attributes
	ROOTCLASSES = None
	This class is the base class for Studio Assist schema generators that are based on XML-enabled class definitions. More...
	SACATEGORY = None
	Optional. More...
	XMLNAMESPACE = None
	This is the namespace value used to identify this SA schema. More...

Static Private Member Functions
_.Library.Status	__GetSchemaForClasses (_.Library.String pClassList)
	Internal method. More...
_.Library.Status	__loopGlobal (_.Stream.Object pStream)
	Loop through the global to generate the output for the Studio.

Detailed Description

This class is the base class for Studio Assist schema generators that are based on XML-enabled class definitions.

Member Function Documentation

GetAttrsForClass()

_.Library.Status GetAttrsForClass ( _.Library.String  pClass,   pAttrList  )

static

Given a class (and default namespace) find the list of XML attributes.

it can contain.

GetElementsForClass()

_.Library.Status GetElementsForClass ( _.Library.String  pClass,   pElementList,   pReferencedClasses  )

static

Given a class (and default namespace) find the list of XML elements.

it can contain. This list of the form: ^List(el) = class

__GetSchemaForClasses()

_.Library.Status __GetSchemaForClasses ( _.Library.String  pClassList )

staticprivate

Internal method.

Given an array of class names, that correspond to the top-level elements within an XML document, find the simplified SASchema used by the Studio Assistant.
ppDefaultNS is the default XML namespace for the schema.

GetXMLElementsForClass()

_.Library.Status GetXMLElementsForClass ( _.Library.String  pClass,   pElements  )

static

Return an array of XML element names that could be used within a.

document wherever pClass is expected.

GetXMLNameForClass()

_.Library.String GetXMLNameForClass ( _.Library.String  pClass )

static

Return the XML name for the given class (or "" if there is none).

If the class is not in the default namespace, its namespace will be prepended to the XML name.

IsUpToDate()

_.Library.Boolean IsUpToDate ( _.Library.String  pChecksum, _.Library.String  pParameter  )

static

Subclass should override this method.

Return a boolean to indicate whether the output associated with the pChecksum is still up-to-date or not.

Reimplemented from SASchema.

XMLName2DisplayName()

_.Library.String XMLName2DisplayName ( _.Library.String  pName, _.Library.String  pCurrentNS  )

static

Take an element and make sure it has the correct namespace prefix.

to match the given local namespace context.

Member Data Documentation

ROOTCLASSES

ROOTCLASSES = None

static

This class is the base class for Studio Assist schema generators that are based on XML-enabled class definitions.

This is a comma-separated list of the classes whose xml elements

can be used as the root level element of a document separated with a ':' and the XML tag name to correlate this with e.g. "User.Person:person,User.Company:company".

SACATEGORY

SACATEGORY = None

static

Optional.

This is a comma-separated list of category names. If specified,

only classes that contain an SACATEGORY parameter included in the list will be added to the schema. This provides a way to create a subset of a larger set of components.

XMLNAMESPACE

XMLNAMESPACE = None

static

This is the namespace value used to identify this SA schema.

This corresponds to the XMLNamespace keyword of a Studio XData block.