weblogic.xml.schema.binding

Interface TypeMappingBuilder

public interface TypeMappingBuilder

TypeMappingBuilder provides a mechansim to build and populate a TypeMapping.

It represents a compile-time construct which need not be present during runtime use of a TypeMapping.

See Also:

TypeMapping

Excluded in public API Reference.

Method Summary

Modifier and Type	Method and Description
void	addMapping(java.lang.Class clazz) create a TypeMappingEntry for this class by generating a corresponding xsd type using the binding configuration and class context information.
void	addMapping(java.lang.Class[] classes) effecient way to add multiple classes.
void	addMapping(java.lang.Class[] classes, XMLName[] element_names) effecient way to add multiple classes.
void	addMapping(java.lang.Class clazz, ClassContext ctx) create a TypeMappingEntry for this class by generating a corresponding xsd type using the binding configuration and class context information.
void	addMapping(XMLName xml_type) create a TypeMappingEntry for this class by generating a corresponding java class using the binding configuration.
void	addMapping(XMLName xml_type, SchemaContext ctx) create a TypeMappingEntry for this class by generating a corresponding java class using the binding configuration.
void	addMapping(XMLName xml_name, XMLInputStream reader) create a TypeMappingEntry for this class by generating a corresponding java class using the binding configuration and schema context.
void	addMapping(XMLName xml_name, XMLInputStream reader, SchemaContext ctx) create a TypeMappingEntry for this class by generating a corresponding java class using the binding configuration and schema context.
void	addWrappedSchemaType(java.lang.Class[] classes, java.lang.String[] element_names, XMLName type_name) Create a schema type that wraps the xml types corresponding to the passed-in java types.
void	addWrappedSchemaType(java.lang.Class[] classes, java.lang.String[] element_names, XMLName[] xml_names, XMLName type_name)
void	fillMappings() create serializers and deserialzers, in whatever manner is appropriate for this style, for each mapping added through the addMapping methods in this object.
BindingConfiguration	getBindingConfiguration() Get the BindingConfiguration for this builder.
java.util.Iterator	getReferredClasses() get all classes referred to in the java introspection process
TypeMapping	getTypeMapping() Finalize and return the TypeMapping for this class by generating appropriate Serializers and Deserializers for those TypeMappingEntry entries that have been added.
boolean	isEmpty() is this builder's type mapping empty?
void	processSchemas(XMLInputStream reader, java.lang.String origin_url) generate the corresponding java classes, serializers, and deserializers for a group of schemas, mapping schema namespace URI's to java package names.
void	processSchemaTypes(XMLInputStream reader, java.lang.String origin_url, TypeDescriptor[] types) generate the corresponding java classes, serializers, and deserializers for a the given types found in the passed in xml input stream, mapping schema namespace URI's to java package names.
void	registerSchema(XMLInputStream reader) register a schema for a possible future mapping.
void	setBindingConfiguration(BindingConfiguration c) Set the BindingConfiguration for this builder.
void	setTypeMapping(TypeMapping mapping)
void	writeGeneratedSchemas(XMLOutputStream stream) Write out the schemas generated by calls to addMapping(XMLName,...) to the provided stream.
void	writeRegisteredSchemas(XMLOutputStream stream) Write out the schemas generated by calls to registerSchema() to the provided stream.

Method Detail

setBindingConfiguration

void setBindingConfiguration(BindingConfiguration c)

Set the BindingConfiguration for this builder.

See Also:

BindingConfiguration

getBindingConfiguration

BindingConfiguration getBindingConfiguration()

Get the BindingConfiguration for this builder.

See Also:

BindingConfiguration

addMapping

void addMapping(java.lang.Class clazz,
                ClassContext ctx)
         throws BindingException

create a TypeMappingEntry for this class by generating a corresponding xsd type using the binding configuration and class context information.

The serialzer and deserialzer portions of the mapping are not created by this method. That is done when getTypeMapping() is called.

Throws:

BindingException

See Also:

TypeMappingBuilder.getTypeMapping()

addMapping

void addMapping(java.lang.Class clazz)
         throws BindingException

create a TypeMappingEntry for this class by generating a corresponding xsd type using the binding configuration and class context information.

Throws:

BindingException

addMapping

void addMapping(java.lang.Class[] classes)
         throws BindingException

effecient way to add multiple classes.

Throws:

BindingException

See Also:

TypeMappingBuilder.addMapping(Class)

addMapping

void addMapping(java.lang.Class[] classes,
                XMLName[] element_names)
         throws BindingException

effecient way to add multiple classes. For each class, a top level element will be added to the generated schema. The element_names array should parallel the classes array to provide the name of the mapped element.

Throws:

BindingException

See Also:

TypeMappingBuilder.addMapping(Class)

addMapping

void addMapping(XMLName xml_name,
                XMLInputStream reader,
                SchemaContext ctx)
         throws BindingException

create a TypeMappingEntry for this class by generating a corresponding java class using the binding configuration and schema context.

The serialzer and deserialzer portions of the mapping are not created by this method. fillMappings must be called to do that.

Parameters:

xml_name - The name of the Schema Type

reader - The XML stream containing the Schema to deserialize

ctx - Context information about the Schema

Throws:

BindingException

addMapping

void addMapping(XMLName xml_name,
                XMLInputStream reader)
         throws BindingException

create a TypeMappingEntry for this class by generating a corresponding java class using the binding configuration and schema context.

Parameters:

xml_name - The name of the Schema Type

reader - The XML stream containing the Schema to deserialize

Throws:

BindingException

addMapping

void addMapping(XMLName xml_type)
         throws BindingException

create a TypeMappingEntry for this class by generating a corresponding java class using the binding configuration. The definition for xml_type will be drawn from a schema that has been registered via registerSchema.

Parameters:

xml_type - The name of the type to map

Throws:

BindingException

See Also:

TypeMappingBuilder.registerSchema(weblogic.xml.stream.XMLInputStream)

addMapping

void addMapping(XMLName xml_type,
                SchemaContext ctx)
         throws BindingException

create a TypeMappingEntry for this class by generating a corresponding java class using the binding configuration. The definition for xml_type will be drawn from a schema that has been registered via registerSchema.

Parameters:

xml_type - The name of the type to map

ctx - context info

Throws:

BindingException

See Also:

TypeMappingBuilder.registerSchema(weblogic.xml.stream.XMLInputStream)

registerSchema

void registerSchema(XMLInputStream reader)
             throws BindingException

register a schema for a possible future mapping.

Throws:

BindingException

processSchemas

void processSchemas(XMLInputStream reader,
                    java.lang.String origin_url)
             throws BindingException

generate the corresponding java classes, serializers, and deserializers for a group of schemas, mapping schema namespace URI's to java package names.

Throws:

BindingException

processSchemaTypes

void processSchemaTypes(XMLInputStream reader,
                        java.lang.String origin_url,
                        TypeDescriptor[] types)
                 throws BindingException

generate the corresponding java classes, serializers, and deserializers for a the given types found in the passed in xml input stream, mapping schema namespace URI's to java package names.

Throws:

BindingException

getTypeMapping

TypeMapping getTypeMapping()
                    throws BindingException

Finalize and return the TypeMapping for this class by generating appropriate Serializers and Deserializers for those TypeMappingEntry entries that have been added.

Throws:

BindingException

setTypeMapping

void setTypeMapping(TypeMapping mapping)

fillMappings

void fillMappings()
           throws BindingException

create serializers and deserialzers, in whatever manner is appropriate for this style, for each mapping added through the addMapping methods in this object.

Throws:

BindingException

addWrappedSchemaType

void addWrappedSchemaType(java.lang.Class[] classes,
                          java.lang.String[] element_names,
                          XMLName type_name)
                   throws BindingException

Create a schema type that wraps the xml types corresponding to the passed-in java types. Each type should already be in the type mapping.

Parameters:

classes - list of classes

classes - list of element names -- parallel to classes

type_name - name of the complexType

Throws:

BindingException

addWrappedSchemaType

void addWrappedSchemaType(java.lang.Class[] classes,
                          java.lang.String[] element_names,
                          XMLName[] xml_names,
                          XMLName type_name)
                   throws BindingException

Throws:

BindingException

writeGeneratedSchemas

void writeGeneratedSchemas(XMLOutputStream stream)
                    throws BindingException

Write out the schemas generated by calls to addMapping(XMLName,...) to the provided stream.

Throws:

BindingException

writeRegisteredSchemas

void writeRegisteredSchemas(XMLOutputStream stream)
                     throws BindingException

Write out the schemas generated by calls to registerSchema() to the provided stream.

Throws:

BindingException

getReferredClasses

java.util.Iterator getReferredClasses()

get all classes referred to in the java introspection process

isEmpty

boolean isEmpty()

is this builder's type mapping empty?