org.jibx.schema.codegen.custom

Class SchemaRootBase

java.lang.Object

org.jibx.schema.codegen.custom.CustomBase

org.jibx.schema.codegen.custom.NestingCustomBase

org.jibx.schema.codegen.custom.SchemaRootBase

All Implemented Interfaces:

TypeReplacer

Direct Known Subclasses:

SchemaCustom, SchemasetCustom

public abstract class SchemaRootBase
extends NestingCustomBase

Base class for possible root customizations.

Author:

Dennis M. Sosnoski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchemaRootBase.ClassDecoratorUnmarshaller Unmarshaller for class decorator extension elements.
static class	SchemaRootBase.ExtensionUnmarshaller Unmarshaller for extension elements.
static class	SchemaRootBase.NameConverterUnmarshaller Unmarshaller for name converter extension elements.
static class	SchemaRootBase.SchemaTypeUnmarshaller Unmarshaller for schema-type elements.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENUM_JAVA5
static int	ENUM_SIMPLE
static int	REPEAT_ARRAY
static int	REPEAT_LIST
static int	REPEAT_TYPED
static StringArray	s_allowedAttributes Enumeration of allowed attribute names
static EnumSet	s_enumValues
static EnumSet	s_repeatValues

Fields inherited from class org.jibx.schema.codegen.custom.NestingCustomBase

ANY_DISCARD, ANY_DOM, ANY_MAPPED, s_anyValues, s_selectionValues, SELECTION_CHECKEDBOTH, SELECTION_CHECKEDSET, SELECTION_OVERRIDEBOTH, SELECTION_OVERRIDESET, SELECTION_UNCHECKED

Constructor Summary

Constructors

Constructor and Description
SchemaRootBase(SchemaRootBase parent) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBindingFileName() Get binding definition file name.
String	getEnumerationTypeText() Get the enumeration representation text value set specifically for this element.
int	getEnumType() Get the enumeration representation type code to be applied for this schema or set of schemas.
int	getLineWidth() Get the preferred maximum line width used for generated classes.
String	getPackage() Get fully-qualified package name.
String	getPrefix() Get prefix used for namespace.
String	getRepeatedTypeText() Get the repeated value representation text value set specifically for this element.
int	getRepeatType() Get the repeated value representation type code to be applied for this schema or set of schemas.
SchemaRootBase	getRootParent() Get parent customization (which will either be null, or another instance of this class).
boolean	isBindingPerSchema() Check if a separate binding should be generated for each schema.
boolean	isDeleteAnnotations() Check whether annotations are to be deleted.
boolean	isGenerateAll() Check whether unused definitions should be included in code generation.
boolean	isInlineGroups() Check whether xs:group and xs:attributeGroup definitions should be inlined by default.
boolean	isJavaDocDocumentation() Check whether schema documentation is to be used for JavaDocs in the generated code.
boolean	isNullCollectionAllowed() Check whether collection holder (array, list, etc.) can be null.
boolean	isPreferInline() Check whether inlining of components is preferred.
boolean	isSchemaFragmentDocumentation() Check whether schema fragments matching a generated class are to be included in the class JavaDocs.
boolean	isStructureOptional() Check whether references to classes with no associated element and all components optional should be made optional in the generated binding.
boolean	isUseInner() Check whether inner classes are preferred for components used only by one definition.
void	setEnumType(int code) Set the enumeration representation type code.
void	setPackage(String pack) Set fully-qualified package name.
void	setRepeatType(int code) Set the repeated value representation type code.

Methods inherited from class org.jibx.schema.codegen.custom.NestingCustomBase

getActiveFacetsMask, getAnyHandling, getAnyType, getChildren, getChoiceHandling, getChoiceType, getReplacement, getSubstitutions, getUnionHandling, getUnionType, isAttributeInlined, isChoiceExposed, isUnionExposed, setAnyType, setChoiceType, setEnforcedFacets, setIgnoredFacets, setReplacement, setSubstitutions, setUnionType, validate

Methods inherited from class org.jibx.schema.codegen.custom.CustomBase

getContainingObject, getParent, getSchemaRoot, setParent, validateAttributes

Methods inherited from class java.lang.Object

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

Field Detail

s_allowedAttributes

public static final StringArray s_allowedAttributes

Enumeration of allowed attribute names

REPEAT_ARRAY

public static final int REPEAT_ARRAY

See Also:

Constant Field Values

REPEAT_LIST

public static final int REPEAT_LIST

See Also:

Constant Field Values

REPEAT_TYPED

public static final int REPEAT_TYPED

See Also:

Constant Field Values

s_repeatValues

public static final EnumSet s_repeatValues

ENUM_JAVA5

public static final int ENUM_JAVA5

See Also:

Constant Field Values

ENUM_SIMPLE

public static final int ENUM_SIMPLE

See Also:

Constant Field Values

s_enumValues

public static final EnumSet s_enumValues

Constructor Detail

SchemaRootBase

public SchemaRootBase(SchemaRootBase parent)

Constructor.

Parameters:

parent -

Method Detail

getRootParent

public SchemaRootBase getRootParent()

Get parent customization (which will either be null, or another instance of this class).

Returns:

parent, or null if none

isBindingPerSchema

public boolean isBindingPerSchema()

Check if a separate binding should be generated for each schema. The default is false if not overridden at any level.

Returns:

generate unused flag

isGenerateAll

public boolean isGenerateAll()

Check whether unused definitions should be included in code generation. The default is true if not overridden at any level.

Returns:

generate unused flag

isInlineGroups

public boolean isInlineGroups()

Check whether xs:group and xs:attributeGroup definitions should be inlined by default. The default is false if not overridden at any level.

Returns:

generate unused flag

isPreferInline

public boolean isPreferInline()

Check whether inlining of components is preferred. The default is false if not overridden at any level.

Returns:

inline components flag

isUseInner

public boolean isUseInner()

Check whether inner classes are preferred for components used only by one definition. The default is true if not overridden at any level.

Returns:

inline components flag

isDeleteAnnotations

public boolean isDeleteAnnotations()

Check whether annotations are to be deleted. The default is true if not overridden at any level.

Returns:

delete annotations flag

isJavaDocDocumentation

public boolean isJavaDocDocumentation()

Check whether schema documentation is to be used for JavaDocs in the generated code. The default is true if not overridden at any level.

Returns:

use schema documentation in JavaDocs flag

isSchemaFragmentDocumentation

public boolean isSchemaFragmentDocumentation()

Check whether schema fragments matching a generated class are to be included in the class JavaDocs. The default is true if not overridden at any level.

Returns:

schema fragments in class JavaDocs flag

isNullCollectionAllowed

public boolean isNullCollectionAllowed()

Check whether collection holder (array, list, etc.) can be null. This is only relevant to collections using an optional wrapper element: If this flag is true a null collection holder indicates the element is missing; otherwise a class is created to wrap the collection holder, and a null for that class indicates the element is missing. The default is true if not overridden at any level. TODO: currently unsupported

Returns:

force collection wrapper flag

isStructureOptional

public boolean isStructureOptional()

Check whether references to classes with no associated element and all components optional should be made optional in the generated binding. The effect of making such class references optional is that the reference will be set null when unmarshalling if none of the components are present, and will be checked for null when marshalling. The default is true if not overridden at any level.

Returns:

prefer structure optional flag

getLineWidth

public int getLineWidth()

Get the preferred maximum line width used for generated classes. The default is 80.

Returns:

line width

getRepeatType

public int getRepeatType()

Get the repeated value representation type code to be applied for this schema or set of schemas. The default value is REPEAT_TYPED if not overridden at any level.

Returns:

code

setRepeatType

public void setRepeatType(int code)

Set the repeated value representation type code.

Parameters:

code - type code, -1 if to be unset

getRepeatedTypeText

public String getRepeatedTypeText()

Get the repeated value representation text value set specifically for this element.

Returns:

text (null if not set)

getEnumType

public int getEnumType()

Get the enumeration representation type code to be applied for this schema or set of schemas. The default value is ENUM_JAVA5 if not overridden at any level.

Returns:

code

setEnumType

public void setEnumType(int code)

Set the enumeration representation type code.

Parameters:

code - type code, -1 if to be unset

getEnumerationTypeText

public String getEnumerationTypeText()

Get the enumeration representation text value set specifically for this element.

Returns:

text (null if not set)

getPackage

public String getPackage()

Get fully-qualified package name. This is inherited by nested schemas if set at any level.

Returns:

package (null if none set)

setPackage

public void setPackage(String pack)

Set fully-qualified package name. This is inherited by nested schemas if set at any level.

Parameters:

pack - (null if none)

getBindingFileName

public String getBindingFileName()

Get binding definition file name. The binding name may not be set if more than one namespace is used in the schemas represented by this customization.

Returns:

name, null if to be derived from schema name

getPrefix

public String getPrefix()

Get prefix used for namespace. The prefix may not be set if more than one namespace is used in the schemas represented by this customization.

Returns:

prefix, null if to be found from schema