org.frankframework.frankdoc

Class DocWriterNew

java.lang.Object

org.frankframework.frankdoc.DocWriterNew

public class DocWriterNew
extends Object

This class writes the XML schema document (XSD) that checks the validity of a Frank configuration XML file. The XML schema is written based on the information in a FrankDocModel object (the model).

Summary of XSD definitions

Here is a summary of all definitions that appear in the XSD:

Kind	Name suffix	Explanation
xs:element	n/a	Allows the integration specialist to use a tag.
xs:complexType	Type	Expresses the allowed contents of a FrankElement, to be referenced in config child groups where the element is allowed.
xs:complexType	Type	Expresses the allowed contents of a FrankElement such that it can be reused for different roles.
xs:attributeGroup	DeclaredAttributeGroup	Groups the attributes that a FrankElement allows, omitting inherited attributes.
xs:attributeGroup	CumulativeAttributeGroup	Groups the attributes that a FrankElement allows, including inherited attributes.
xs:group	DeclaredChildGroup	Defines a list of tags that is allowed within a parent tag, disregarding inheritance.
xs:group	CumulativeChildGroup	Defines a list of tags that is allowed within a parent tag, including inheritance.
xs:group	ElementGroup	Lists all choices that are allowed for a child tag, including the generic element option.
xs:group	ElementGroupBase	Lists all choices that are allowed for a child tag, excluding the generic element option.
xs:simpleType	AttributeValuesType	For attributes constrained by a Java enum, list all allowed values

Author:

martijn

Constructor Summary

Constructors

Constructor and Description
DocWriterNew(FrankDocModel model, AttributeTypeStrategy attributeTypeStrategy, String frankFrameworkVersion)

Method Summary

Modifier and Type	Method and Description
void	addAttributeInline(FrankAttribute attribute, XmlBuilder group, String targetName)
void	addReusableAttribute(FrankAttribute attribute)
void	addReusedAttributeReference(FrankAttribute attribute, XmlBuilder group, String targetName)
String	getSchema()
void	init(XsdVersion version)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocWriterNew

public DocWriterNew(FrankDocModel model,
                    AttributeTypeStrategy attributeTypeStrategy,
                    String frankFrameworkVersion)

Method Detail

init

public void init(XsdVersion version)

getSchema

public String getSchema()

addAttributeInline

public void addAttributeInline(FrankAttribute attribute,
                               XmlBuilder group,
                               String targetName)

addReusableAttribute

public void addReusableAttribute(FrankAttribute attribute)

addReusedAttributeReference

public void addReusedAttributeReference(FrankAttribute attribute,
                                        XmlBuilder group,
                                        String targetName)