org.jibx.schema.codegen.custom

Class SchemasetCustom

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.SchemasetCustom

All Implemented Interfaces:

TypeReplacer

public class SchemasetCustom
extends SchemaRootBase

Customization information for a set of schemas.

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
SchemasetCustom(SchemaCustom child) Constructor with single schema customization as content.
SchemasetCustom(SchemasetCustom parent) Normal constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkSchemas(ValidationContext vctx) Recursively check that each schema customization has been matched to a schema.
SchemaCustom	forceCustomization(String name, String id, SchemaElement schema, ValidationContext vctx) Get schema customization information, creating it if it doesn't already exist.
SchemaCustom	getCustomization(String id) Get existing schema customization information.
String[]	getNames() Get schema name match patterns.
boolean	isInSet(String name, SchemaElement schema) Check if a schema is included in this set.
static SchemasetCustom	loadCustomizations(String path, ProblemHandler handler) Load a customizations file.
boolean	validate(ValidationContext vctx) Validate and finalize customization information.

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

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

SchemasetCustom

public SchemasetCustom(SchemasetCustom parent)

Normal constructor.

Parameters:

parent -

SchemasetCustom

public SchemasetCustom(SchemaCustom child)

Constructor with single schema customization as content.

Parameters:

child -

Method Detail

getNames

public String[] getNames()

Get schema name match patterns.

Returns:

names (null if not set)

isInSet

public boolean isInSet(String name,
              SchemaElement schema)

Check if a schema is included in this set.

Parameters:

name - schema file name

schema - actual schema

Returns:

true if in set, false if not

getCustomization

public SchemaCustom getCustomization(String id)

Get existing schema customization information.

Parameters:

id - schema identifier

Returns:

customization

forceCustomization

public SchemaCustom forceCustomization(String name,
                              String id,
                              SchemaElement schema,
                              ValidationContext vctx)

Get schema customization information, creating it if it doesn't already exist.

Parameters:

name - schema file name

id - unique identifier for schema

schema - actual schema

vctx - validation context for reporting errors

Returns:

customization

checkSchemas

public void checkSchemas(ValidationContext vctx)

Recursively check that each schema customization has been matched to a schema. A warning is generated for any customization without a matching schema.

Parameters:

vctx -

validate

public boolean validate(ValidationContext vctx)

Validate and finalize customization information. This override of the base class implementation also invokes the same method on any nested schemasets in order to make sure that the type substitution map and active facets mask will be available for use by nested schemas.

Overrides:

validate in class NestingCustomBase

Parameters:

vctx - validation context

Returns:

true if valid, false if not

loadCustomizations

public static SchemasetCustom loadCustomizations(String path,
                                 ProblemHandler handler)
                                          throws JiBXException,
                                                 IOException

Load a customizations file. The specified file must exist and have as root element either a <schema-set> or <schema> element.

Parameters:

path - customization file path (null if none)

handler - validation problem handler

Returns:

unmarshalled customizations, or null if errors

Throws:

JiBXException

IOException