Package org.jibx.schema.codegen.custom
Class NestingCustomBase
java.lang.Object
org.jibx.schema.codegen.custom.CustomBase
org.jibx.schema.codegen.custom.NestingCustomBase
- All Implemented Interfaces:
TypeReplacer
- Direct Known Subclasses:
ComponentCustom
,SchemaRootBase
Base class for all standard schema customizations that can contain other customizations.
- Author:
- Dennis M. Sosnoski
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
private long
Mask for facets active at this level (all facets not in scope of an ignore state).private int
Code for xs:any representation (-1
if not set at level).private final LazyList
Child customizations.private int
Code for xs:choice handling (-1
if not set at level).private Boolean
Expose choice selection state directly to user.private long
Mask for facets enforced at this level.private long
Mask for facets ignored at this level.private QName[]
List of type substitution pairs.private Map
Map of type substitutions.private int
Code for xs:union handling (-1
if not set at level).private Boolean
Expose union selection state directly to user.static final StringArray
Enumeration of allowed attribute namesstatic final EnumSet
static final EnumSet
static final int
static final int
static final int
static final int
static final int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionlong
Get the bitmask of facet element flags to be processed.Get the xs:any handling text value set specifically for this element.int
Get the xs:any handling type code to be applied for this component and all nested components.Get child customizations.Get the xs:choice handling text value set specifically for this element.int
Get the xs:choice handling type code to be applied for this component and all nested components.getReplacement
(QName qname) Get replacement type.QName[]
Get type substitution pairs list.Get the xs:union handling text value set specifically for this element.int
Get the xs:union handling type code to be applied for this component and all nested components.boolean
Check whether xs:attribute definitions should always be inlined, even when used in multiple locations.boolean
Check whether xs:choice selection states should be exposed to the user.boolean
Check whether xs:union selection states should be exposed to the user.private void
setAnyHandling
(String text, IUnmarshallingContext ictx) Set the xs:any handling text value.void
setAnyType
(int code) Set the xs:any handling type code.private void
setChoiceHandling
(String text, IUnmarshallingContext ictx) Set the xs:choice handling text value.void
setChoiceType
(int code) Set the xs:choice handling type code.void
setEnforcedFacets
(String[] facets, IUnmarshallingContext ictx) Set the list of facet elements to be enforced.void
setIgnoredFacets
(String[] facets, IUnmarshallingContext ictx) Set the list of facet elements to be ignored.protected void
setReplacement
(QName original, QName replace) Set a type replacement.void
setSubstitutions
(QName[] subs) Set type substitution pairs list.private void
setUnionHandling
(String text, IUnmarshallingContext ictx) Set the xs:union handling text value.void
setUnionType
(int code) Set the xs:union handling type code.boolean
validate
(ValidationContext vctx) Validate and finalize customization information.Methods inherited from class org.jibx.schema.codegen.custom.CustomBase
getContainingObject, getParent, getSchemaRoot, setParent, validateAttributes
-
Field Details
-
s_allowedAttributes
Enumeration of allowed attribute names -
ANY_DISCARD
public static final int ANY_DISCARD- See Also:
-
ANY_DOM
public static final int ANY_DOM- See Also:
-
ANY_MAPPED
public static final int ANY_MAPPED- See Also:
-
s_anyValues
-
SELECTION_UNCHECKED
public static final int SELECTION_UNCHECKED- See Also:
-
SELECTION_CHECKEDSET
public static final int SELECTION_CHECKEDSET- See Also:
-
SELECTION_CHECKEDBOTH
public static final int SELECTION_CHECKEDBOTH- See Also:
-
SELECTION_OVERRIDESET
public static final int SELECTION_OVERRIDESET- See Also:
-
SELECTION_OVERRIDEBOTH
public static final int SELECTION_OVERRIDEBOTH- See Also:
-
s_selectionValues
-
m_substitutions
List of type substitution pairs. -
m_enforcedFacetsMask
private long m_enforcedFacetsMaskMask for facets enforced at this level. -
m_ignoredFacetsMask
private long m_ignoredFacetsMaskMask for facets ignored at this level. -
m_choiceExposed
Expose choice selection state directly to user. -
m_choiceCode
private int m_choiceCodeCode for xs:choice handling (-1
if not set at level). -
m_unionExposed
Expose union selection state directly to user. -
m_unionCode
private int m_unionCodeCode for xs:union handling (-1
if not set at level). -
m_anyCode
private int m_anyCodeCode for xs:any representation (-1
if not set at level). -
m_children
Child customizations. -
m_typeSubstitutionMap
Map of type substitutions. -
m_activeFacetsMask
private long m_activeFacetsMaskMask for facets active at this level (all facets not in scope of an ignore state).
-
-
Constructor Details
-
NestingCustomBase
Constructor.- Parameters:
parent
-
-
-
Method Details
-
getSubstitutions
Get type substitution pairs list.- Returns:
- substitutions
-
setSubstitutions
Set type substitution pairs list.- Parameters:
subs
-
-
setEnforcedFacets
Set the list of facet elements to be enforced.- Parameters:
facets
-ictx
-
-
setIgnoredFacets
Set the list of facet elements to be ignored.- Parameters:
facets
-ictx
-
-
getActiveFacetsMask
public long getActiveFacetsMask()Get the bitmask of facet element flags to be processed.- Returns:
- bitmask
-
getChildren
Get child customizations.- Returns:
- children
-
setReplacement
Set a type replacement.- Parameters:
original
-replace
-
-
getReplacement
Get replacement type.- Specified by:
getReplacement
in interfaceTypeReplacer
- Parameters:
qname
-- Returns:
- replacement type (
null
if deletion; original type, if no replacement defined)
-
getAnyType
public int getAnyType()Get the xs:any handling type code to be applied for this component and all nested components. The default value isANY_DOM
if not overridden at any level.- Returns:
- code
-
setAnyType
public void setAnyType(int code) Set the xs:any handling type code.- Parameters:
code
- handling code,-1
if to be unset
-
getAnyHandling
Get the xs:any handling text value set specifically for this element.- Returns:
- text (
null
if not set)
-
setAnyHandling
Set the xs:any handling text value. This method is provided only for use when unmarshalling.- Parameters:
text
- (null
if not set)ictx
-
-
isChoiceExposed
public boolean isChoiceExposed()Check whether xs:choice selection states should be exposed to the user. The default isfalse
if not overridden at any level.- Returns:
- expose choice state flag
-
getChoiceType
public int getChoiceType()Get the xs:choice handling type code to be applied for this component and all nested components. The default value isSELECTION_CHECKEDSET
if not overridden at any level.- Returns:
- code
-
setChoiceType
public void setChoiceType(int code) Set the xs:choice handling type code.- Parameters:
code
- handling code,-1
if to be unset
-
getChoiceHandling
Get the xs:choice handling text value set specifically for this element.- Returns:
- text (
null
if not set)
-
setChoiceHandling
Set the xs:choice handling text value. This method is provided only for use when unmarshalling.- Parameters:
text
- (null
if not set)ictx
-
-
isUnionExposed
public boolean isUnionExposed()Check whether xs:union selection states should be exposed to the user. The default isfalse
if not overridden at any level.- Returns:
- expose union state flag
-
getUnionType
public int getUnionType()Get the xs:union handling type code to be applied for this component and all nested components. The default value isSELECTION_CHECKEDSET
if not overridden at any level.- Returns:
- code
-
setUnionType
public void setUnionType(int code) Set the xs:union handling type code.- Parameters:
code
- handling code,-1
if to be unset
-
getUnionHandling
Get the xs:union handling text value set specifically for this element.- Returns:
- text (
null
if not set)
-
setUnionHandling
Set the xs:union handling text value. This method is provided only for use when unmarshalling.- Parameters:
text
- (null
if not set)ictx
-
-
isAttributeInlined
public boolean isAttributeInlined()Check whether xs:attribute definitions should always be inlined, even when used in multiple locations. The default isfalse
if not overridden at any level. TODO: implement in customizations- Returns:
- inline attribute flag
-
validate
Validate and finalize customization information. This creates a new type substitution map and active facets mask, or inherits unchanged values from the parent customization.- Parameters:
vctx
- validation context- Returns:
true
if valid,false
if not
-