org.jibx.schema.codegen.custom

Class SchemaCustom

java.lang.Object

org.jibx.schema.codegen.custom.CustomBase

org.jibx.schema.codegen.custom.NestingCustomBase

org.jibx.schema.codegen.custom.SchemaRootBase

org.jibx.schema.codegen.custom.SchemaCustom

All Implemented Interfaces:

TypeReplacer

public class SchemaCustom
extends SchemaRootBase

Individual schema customization information.

Author:

Dennis M. Sosnoski

Nested Class Summary

Nested classes/interfaces inherited from class org.jibx.schema.codegen.custom.SchemaRootBase

SchemaRootBase.ClassDecoratorUnmarshaller, SchemaRootBase.ExtensionUnmarshaller, SchemaRootBase.NameConverterUnmarshaller, SchemaRootBase.SchemaTypeUnmarshaller

Field Summary

Fields

Modifier and Type	Field and Description
static StringArray	s_allowedAttributes Enumeration of allowed attribute names

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

ENUM_JAVA5, ENUM_SIMPLE, REPEAT_ARRAY, REPEAT_LIST, REPEAT_TYPED, s_enumValues, 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
SchemaCustom(SchemasetCustom parent) Constructor.
SchemaCustom(SchemasetCustom parent, String name, String namespace, String[] includes, String[] excludes) Constructor for constructing instance directly.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkMatch(String name, SchemaElement schema) Check if this customization matches a particular schema.
void	extend(PackageHolder pack, ValidationContext vctx) Build the schema extension structure.
String[]	getExcludes() Get the names of definitions to be excluded from generation.
String[]	getIncludes() Get the names of definitions to be included in generation.
String	getName() Get schema name.
String	getNamespace() Get schema namespace.
SchemaElement	getSchema() Get schema definition.
boolean	isForceTypes() Check if type specifications forced for schema.
void	setExcludes(String[] excludes) Set the names of definitions to be excluded from generation.
void	setForceTypes(Boolean force) Set type specifications forced for schema.
void	setIncludes(String[] includes) Set the names of definitions to be included in generation.
void	setName(String name) Set schema name.
void	setNamespace(String namespace) Set schema namespace.
void	setSchema(String name, SchemaElement schema) Set schema definition.
void	stripAnnotations() Strip the annotation components (at any level) from a schema definitions.

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

getBindingFileName, getEnumerationTypeText, getEnumType, getLineWidth, getPackage, getPrefix, getRepeatedTypeText, getRepeatType, getRootParent, isBindingPerSchema, isDeleteAnnotations, isGenerateAll, isInlineGroups, isJavaDocDocumentation, isNullCollectionAllowed, isPreferInline, isSchemaFragmentDocumentation, isStructureOptional, isUseInner, setEnumType, setPackage, setRepeatType

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

Constructor Detail

SchemaCustom

public SchemaCustom(SchemasetCustom parent)

Constructor.

Parameters:

parent -

SchemaCustom

public SchemaCustom(SchemasetCustom parent,
            String name,
            String namespace,
            String[] includes,
            String[] excludes)

Constructor for constructing instance directly.

Parameters:

parent -

name - schema name

namespace - target namespace URI

includes - definition names to be included in generation

excludes - definition names to be excluded from generation

Method Detail

getIncludes

public String[] getIncludes()

Get the names of definitions to be included in generation.

Returns:

names

setIncludes

public void setIncludes(String[] includes)

Set the names of definitions to be included in generation. This only has any effect on the code generation if called before extend(PackageHolder, ValidationContext) is called.

Parameters:

includes -

getExcludes

public String[] getExcludes()

Get the names of definitions to be excluded from generation.

Returns:

names

setExcludes

public void setExcludes(String[] excludes)

Set the names of definitions to be excluded from generation. This only has any effect on the code generation if called before extend(PackageHolder, ValidationContext) is called.

Parameters:

excludes -

getName

public String getName()

Get schema name.

Returns:

name

setName

public void setName(String name)

Set schema name.

Parameters:

name -

getNamespace

public String getNamespace()

Get schema namespace.

Returns:

namespace

setNamespace

public void setNamespace(String namespace)

Set schema namespace.

Parameters:

namespace -

isForceTypes

public boolean isForceTypes()

Check if type specifications forced for schema.

Returns:

true if types forced, false if not

setForceTypes

public void setForceTypes(Boolean force)

Set type specifications forced for schema.

Parameters:

force - true if types forced, false if not

getSchema

public SchemaElement getSchema()

Get schema definition.

Returns:

schema

setSchema

public void setSchema(String name,
             SchemaElement schema)

Set schema definition.

Parameters:

name -

schema -

checkMatch

public boolean checkMatch(String name,
                 SchemaElement schema)

Check if this customization matches a particular schema.

Parameters:

name -

schema -

Returns:

true if a match, false if not

stripAnnotations

public void stripAnnotations()

Strip the annotation components (at any level) from a schema definitions.

extend

public void extend(PackageHolder pack,
          ValidationContext vctx)

Build the schema extension structure. This first builds extensions for all the global definitions in the schema, marking the ones specified to be included or excluded from the schema, and for all the child components of the non-excluded globals. It then applies the customizations to the extensions.

Parameters:

pack - package for generated classes (null if no code generation)

vctx - validation context