org.jibx.binding.model

Class TemplateElement

java.lang.Object

org.jibx.binding.model.ElementBase

org.jibx.binding.model.NestingElementBase

org.jibx.binding.model.ContainerElementBase

org.jibx.binding.model.TemplateElementBase

org.jibx.binding.model.TemplateElement

public class TemplateElement
extends TemplateElementBase

Model component for template element of binding definition.

Author:

Dennis M. Sosnoski

Field Summary

Fields inherited from class org.jibx.binding.model.TemplateElementBase

m_topChildren, s_allowedAttributes

Fields inherited from class org.jibx.binding.model.ElementBase

BINDING_ELEMENT, COLLECTION_ELEMENT, ELEMENT_NAMES, FORMAT_ELEMENT, INCLUDE_ELEMENT, INPUT_ELEMENT, MAPPING_ELEMENT, NAMESPACE_ELEMENT, OUTPUT_ELEMENT, SPLIT_ELEMENT, STRUCTURE_ELEMENT, TEMPLATE_ELEMENT, VALUE_ELEMENT

Constructor Summary

Constructors

Constructor and Description
TemplateElement() Default constructor.

Method Summary

Modifier and Type	Method and Description
String	getBaseName() Get base type name.
NamespaceElement	getBaseNamespace() Get effective namespace information for base type.
String	getBasePrefix() Get namespace URI specified for base type.
String	getBaseUri() Get namespace URI specified for base type.
TemplateElement	getExtendsMapping() Get template extended by this one.
String	getLabel() Get template label.
String	getTypeName() Get type name.
NamespaceElement	getTypeNamespace() Get effective namespace information for type.
String	getTypePrefix() Get namespace prefix specified for type.
String	getTypeUri() Get namespace URI specified for type.
boolean	isDefaultTemplate() Check if default template for type.
void	prevalidate(ValidationContext vctx) Prevalidate attributes of element in isolation.
void	setBaseName(String name) Set base type name.
void	setBasePrefix(String prefix) Set base type namespace prefix.
void	setBaseUri(String uri) Set base type namespace URI.
void	setDefaultTemplate(boolean dflt) Set default template for type flag.
void	setLabel(String label) Set template label.
void	setTypeName(String name) Set type name.
void	setTypePrefix(String prefix) Set type namespace prefix.
void	setTypeUri(String uri) Set type namespace URI.

Methods inherited from class org.jibx.binding.model.TemplateElementBase

addExtensionType, addTopChild, getClassName, getExtensionTypes, getHandledClass, getObjectType, getType, hasObject, isImplicit, isOptional, setClassName, topChildIterator, topChildren, validate

Methods inherited from class org.jibx.binding.model.ContainerElementBase

checkCompatibleChildren, classifyComponents, getAttributeComponents, getChildObjectType, getContentComponents, getCreateClass, getCreateType, getFactory, getFactoryName, getId, getMarshaller, getMarshallerName, getPostset, getPostsetName, getPreget, getPregetName, getPreset, getPresetName, getUnmarshaller, getUnmarshallerName, getUsing, isAllowRepeats, isChoice, isClassified, isFlexible, isNillable, isOrdered, setAllowRepeats, setChoice, setComponents, setCreateType, setFactoryName, setFlexible, setIdChild, setMarshallerName, setNillable, setOrdered, setPostsetName, setPregetName, setPresetName, setUnmarshallerName, setUsing, verifyConstruction

Methods inherited from class org.jibx.binding.model.NestingElementBase

addChild, childIterator, children, getDefaultStyle, getDefinitions, getStyle, getStyleName, setStyleName

Methods inherited from class org.jibx.binding.model.ElementBase

getComment, name, setComment, toString, type, validateAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateElement

public TemplateElement()

Default constructor.

Method Detail

getLabel

public String getLabel()

Get template label.

Overrides:

getLabel in class ContainerElementBase

Returns:

template label (null if none)

setLabel

public void setLabel(String label)

Set template label.

Overrides:

setLabel in class ContainerElementBase

Parameters:

label - template label (null if none)

isDefaultTemplate

public boolean isDefaultTemplate()

Check if default template for type.

Specified by:

isDefaultTemplate in class TemplateElementBase

Returns:

true if default for type, false if not

setDefaultTemplate

public void setDefaultTemplate(boolean dflt)

Set default template for type flag.

Parameters:

dflt - true if default for type, false if not

getTypeName

public String getTypeName()

Get type name.

Returns:

type name text

setTypeName

public void setTypeName(String name)

Set type name.

Parameters:

name - text for type name

getTypeUri

public String getTypeUri()

Get namespace URI specified for type.

Returns:

type namespace URI (null if not set)

setTypeUri

public void setTypeUri(String uri)

Set type namespace URI.

Parameters:

uri - type namespace URI (null if not set)

getTypePrefix

public String getTypePrefix()

Get namespace prefix specified for type.

Returns:

type namespace prefix (null if not set)

setTypePrefix

public void setTypePrefix(String prefix)

Set type namespace prefix.

Parameters:

prefix - namespace prefix (null if not set)

getTypeNamespace

public NamespaceElement getTypeNamespace()

Get effective namespace information for type. This call is only meaningful after validation.

Returns:

effective namespace information

getExtendsMapping

public TemplateElement getExtendsMapping()

Get template extended by this one.

Returns:

template extended by this one

getBaseName

public String getBaseName()

Get base type name.

Returns:

base type name text

setBaseName

public void setBaseName(String name)

Set base type name.

Parameters:

name - text for base type name

getBaseUri

public String getBaseUri()

Get namespace URI specified for base type.

Returns:

base type namespace URI (null if not set)

setBaseUri

public void setBaseUri(String uri)

Set base type namespace URI.

Parameters:

uri - base type namespace URI (null if if not set)

getBasePrefix

public String getBasePrefix()

Get namespace URI specified for base type.

Returns:

base type namespace prefix (null if not set)

setBasePrefix

public void setBasePrefix(String prefix)

Set base type namespace prefix.

Parameters:

prefix - base type namespace prefix (null if not set)

getBaseNamespace

public NamespaceElement getBaseNamespace()

Get effective namespace information for base type. This call is only meaningful after validation.

Returns:

effective namespace information

prevalidate

public void prevalidate(ValidationContext vctx)

Prevalidate attributes of element in isolation.

Overrides:

prevalidate in class TemplateElementBase

Parameters:

vctx - validation context