org.apache.axis2.schema.writer
Interface BeanWriter

All Known Implementing Classes:
CStructWriter, JavaBeanWriter

public interface BeanWriter

The bean writer interface. The schema compiler expects one of these to be presented to it and calls the appropriate methods


Method Summary
 java.lang.String getDefaultAttribArrayClassName()
           
 java.lang.String getDefaultAttribClassName()
           
 java.lang.String getDefaultClassArrayName()
           
 java.lang.String getDefaultClassName()
           
 java.lang.String getExtensionMapperPackageName()
          Find whether the mapper class name is present
 java.util.Map getModelMap()
          Gets a map of models.
 void init(CompilerOptions options)
          Initializes the writer with compiler options.
 java.lang.String makeFullyQualifiedClassName(javax.xml.namespace.QName qName)
          Make the fully qualified class name for an element or named type
 void registerExtensionMapperPackageName(java.lang.String mapperPackageName)
          Registers the mapper package name - this is relevant to languages that enforce packaging such as Java or C#.
 java.lang.String write(org.apache.ws.commons.schema.XmlSchemaComplexType complexType, java.util.Map typeMap, BeanWriterMetaInfoHolder metainf)
          Write a complex type
 java.lang.String write(org.apache.ws.commons.schema.XmlSchemaElement element, java.util.Map typeMap, BeanWriterMetaInfoHolder metainf)
          Write a element
 java.lang.String write(org.apache.ws.commons.schema.XmlSchemaSimpleType simpleType, java.util.Map typeMap, BeanWriterMetaInfoHolder metainf)
          Write a simple type
 void writeBatch()
          Writes a wrapped class.
 void writeExtensionMapper(BeanWriterMetaInfoHolder[] metainfArray)
          Write the extensions mapper component - this is relevant to only the OOP languages and a particular implementation may ignore this
 

Method Detail

init

public void init(CompilerOptions options)
          throws SchemaCompilationException
Initializes the writer with compiler options.

Parameters:
options -
Throws:
java.io.IOException
SchemaCompilationException

writeBatch

public void writeBatch()
                throws SchemaCompilationException
Writes a wrapped class. This will have effect only if the CompilerOptions wrapclassses returns true.

Throws:
SchemaCompilationException

getModelMap

public java.util.Map getModelMap()
Gets a map of models. This is useful for tight integrations where the internal workings of the schema compiler may be exposed.


makeFullyQualifiedClassName

public java.lang.String makeFullyQualifiedClassName(javax.xml.namespace.QName qName)
Make the fully qualified class name for an element or named type

Parameters:
qName - the qualified Name for this element or type in the schema
Returns:
the appropriate fully qualified class name to use in generated code

write

public java.lang.String write(org.apache.ws.commons.schema.XmlSchemaComplexType complexType,
                              java.util.Map typeMap,
                              BeanWriterMetaInfoHolder metainf)
                       throws SchemaCompilationException
Write a complex type

Parameters:
complexType -
typeMap -
metainf -
Returns:
Returns String.
Throws:
SchemaCompilationException

write

public java.lang.String write(org.apache.ws.commons.schema.XmlSchemaElement element,
                              java.util.Map typeMap,
                              BeanWriterMetaInfoHolder metainf)
                       throws SchemaCompilationException
Write a element

Parameters:
element -
typeMap -
metainf -
Returns:
Returns String.
Throws:
SchemaCompilationException

write

public java.lang.String write(org.apache.ws.commons.schema.XmlSchemaSimpleType simpleType,
                              java.util.Map typeMap,
                              BeanWriterMetaInfoHolder metainf)
                       throws SchemaCompilationException
Write a simple type

Parameters:
simpleType -
typeMap -
metainf -
Returns:
Returns String.
Throws:
SchemaCompilationException

getExtensionMapperPackageName

public java.lang.String getExtensionMapperPackageName()
Find whether the mapper class name is present


registerExtensionMapperPackageName

public void registerExtensionMapperPackageName(java.lang.String mapperPackageName)
Registers the mapper package name - this is relevant to languages that enforce packaging such as Java or C#. May be ignored in other languages

Parameters:
mapperPackageName -

writeExtensionMapper

public void writeExtensionMapper(BeanWriterMetaInfoHolder[] metainfArray)
                          throws SchemaCompilationException
Write the extensions mapper component - this is relevant to only the OOP languages and a particular implementation may ignore this

Parameters:
metainfArray -
Throws:
SchemaCompilationException

getDefaultClassName

public java.lang.String getDefaultClassName()

getDefaultClassArrayName

public java.lang.String getDefaultClassArrayName()

getDefaultAttribClassName

public java.lang.String getDefaultAttribClassName()

getDefaultAttribArrayClassName

public java.lang.String getDefaultAttribArrayClassName()


Copyright © 2004-2007 Apache Software Foundation. All Rights Reserved.