Module com.sun.tools.xjc

Package com.sun.tools.xjc.model

Class Model

java.lang.Object

com.sun.tools.xjc.model.Model

All Implemented Interfaces:

CCustomizable, TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

public final class Model
extends java.lang.Object
implements TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>, CCustomizable

Root of the object model that represents the code that needs to be generated.

A Model is a schema language neutral representation of the result of a schema parsing. The back-end then works against this model to turn this into a series of Java source code.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
com.sun.codemodel.JCodeModel	codeModel	This model uses this code model exclusively.
SymbolSpace	defaultSymbolSpace	Default ID/IDREF symbol space.
Options	options	Command-line options used for building this model.
com.sun.codemodel.JClass	rootClass	If non-null, all the generated classes should eventually derive from this class.
com.sun.codemodel.JClass	rootInterface	If non-null, all the generated interfaces should eventually derive from this interface.
com.sun.xml.xsom.XSSchemaSet	schemaComponent	If this model was built from XML Schema, this field stores the root object of the parse schema model.
boolean	serializable	True to generate serializable classes.
java.lang.Long	serialVersionUID	serial version UID to be generated.
ImplStructureStrategy	strategy	Specifies the code generation strategy.

Constructor Summary

Constructors

Constructor	Description
Model(Options opts, com.sun.codemodel.JCodeModel cm, NameConverter nc, ClassNameAllocator allocator, com.sun.xml.xsom.XSSchemaSet schemaComponent)

Method Summary

Modifier and Type	Method	Description
java.util.Map<NType,? extends CArrayInfo>	arrays()	No array mapping generation for XJC.
java.util.Map<NClass,CClassInfo>	beans()
java.util.Map<NType,? extends CBuiltinLeafInfo>	builtins()
java.util.Map<javax.xml.namespace.QName,CClassInfo>	createTopLevelBindings()	Represents the "top-level binding".
void	dump(javax.xml.transform.Result out)
java.util.Map<NClass,CEnumLeafInfo>	enums()
Outline	generateCode(Options opt, ErrorReceiver receiver)	Fully-generate the source code into the given model.
java.lang.Iterable<? extends CElementInfo>	getAllElements()
CBuiltinLeafInfo	getAnyTypeInfo()
javax.xml.bind.annotation.XmlNsForm	getAttributeFormDefault(java.lang.String nsUri)
CClassInfo	getClassInfo(NClass t)
CCustomizations	getCustomizations()	Gets the global customizations.
javax.xml.bind.annotation.XmlNsForm	getElementFormDefault(java.lang.String nsUri)
CElementInfo	getElementInfo(NClass scope, javax.xml.namespace.QName name)
java.util.Map<javax.xml.namespace.QName,CElementInfo>	getElementMappings(NClass scope)
org.xml.sax.Locator	getLocator()	Deprecated. No line number available for the "root" component.
NameConverter	getNameConverter()	Gets the name converter that shall be used to parse XML names into Java names.
Navigator<NType,NClass,java.lang.Void,java.lang.Void>	getNavigator()
CClassInfoParent.Package	getPackage(com.sun.codemodel.JPackage pkg)
com.sun.xml.xsom.XSComponent	getSchemaComponent()	Deprecated. Always return null. Perhaps you are interested in schemaComponent?
java.util.Map<java.lang.String,java.lang.String>	getSchemaLocations()
SymbolSpace	getSymbolSpace(java.lang.String name)
CNonElement	getTypeInfo(NType type)
CNonElement	getTypeInfo(Ref<NType,NClass> ref)
java.util.Map<java.lang.String,java.lang.String>	getXmlNs(java.lang.String namespaceUri)	Not implemented in the compile-time model.
boolean	isPackageLevelAnnotations()
void	setNameConverter(NameConverter nameConverter)
void	setPackageLevelAnnotations(boolean packageLevelAnnotations)
java.util.Map<javax.xml.namespace.QName,TypeUse>	typeUses()

Methods inherited from class java.lang.Object

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

Field Detail

schemaComponent

public final com.sun.xml.xsom.XSSchemaSet schemaComponent

If this model was built from XML Schema, this field stores the root object of the parse schema model. Otherwise null.

Since:

2.1.1

codeModel

public final com.sun.codemodel.JCodeModel codeModel

This model uses this code model exclusively.

options

public final Options options

Command-line options used for building this model.

serializable

public boolean serializable

True to generate serializable classes.

serialVersionUID

public java.lang.Long serialVersionUID

serial version UID to be generated. null if not to generate serialVersionUID field.

rootClass

public com.sun.codemodel.JClass rootClass

If non-null, all the generated classes should eventually derive from this class.

rootInterface

public com.sun.codemodel.JClass rootInterface

If non-null, all the generated interfaces should eventually derive from this interface.

strategy

public ImplStructureStrategy strategy

Specifies the code generation strategy. Must not be null.

defaultSymbolSpace

public final SymbolSpace defaultSymbolSpace

Default ID/IDREF symbol space. Any ID/IDREF without explicit reference to a symbol space is assumed to use this default symbol space.

Constructor Detail

Model

public Model(Options opts,
             com.sun.codemodel.JCodeModel cm,
             NameConverter nc,
             ClassNameAllocator allocator,
             com.sun.xml.xsom.XSSchemaSet schemaComponent)

Parameters:

nc - Usually this should be set in the constructor, but we do allow this parameter to be initially null, and then set later.

schemaComponent - The source schema model, if this is built from XSD.

Method Detail

setNameConverter

public void setNameConverter(NameConverter nameConverter)

getNameConverter

public final NameConverter getNameConverter()

Gets the name converter that shall be used to parse XML names into Java names.

isPackageLevelAnnotations

public boolean isPackageLevelAnnotations()

setPackageLevelAnnotations

public void setPackageLevelAnnotations(boolean packageLevelAnnotations)

getSymbolSpace

public SymbolSpace getSymbolSpace(java.lang.String name)

generateCode

public Outline generateCode(Options opt,
                            ErrorReceiver receiver)

Fully-generate the source code into the given model.

Returns:

null if there was any errors. Otherwise it returns a valid Outline object, which captures how the model objects are mapped to the generated source code.

Add-ons can use those information to further augment the generated source code.

createTopLevelBindings

public final java.util.Map<javax.xml.namespace.QName,CClassInfo> createTopLevelBindings()

Represents the "top-level binding".

This is used to support the use of a schema inside WSDL. For XML Schema, the top-level binding is a map from global element declarations to its representation class.

For other schema languages, it should follow the appendices in WSDL (but in practice no one would use WSDL with a schema language other than XML Schema, so it doesn't really matter.)

This needs to be filled by the front-end.

getNavigator

public Navigator<NType,NClass,java.lang.Void,java.lang.Void> getNavigator()

Specified by:

getNavigator in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

getTypeInfo

public CNonElement getTypeInfo(NType type)

Specified by:

getTypeInfo in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

getAnyTypeInfo

public CBuiltinLeafInfo getAnyTypeInfo()

Specified by:

getAnyTypeInfo in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

getTypeInfo

public CNonElement getTypeInfo(Ref<NType,NClass> ref)

Specified by:

getTypeInfo in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

beans

public java.util.Map<NClass,CClassInfo> beans()

Specified by:

beans in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

enums

public java.util.Map<NClass,CEnumLeafInfo> enums()

Specified by:

enums in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

typeUses

public java.util.Map<javax.xml.namespace.QName,TypeUse> typeUses()

arrays

public java.util.Map<NType,? extends CArrayInfo> arrays()

No array mapping generation for XJC.

Specified by:

arrays in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

builtins

public java.util.Map<NType,? extends CBuiltinLeafInfo> builtins()

Specified by:

builtins in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

getClassInfo

public CClassInfo getClassInfo(NClass t)

Specified by:

getClassInfo in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

getElementInfo

public CElementInfo getElementInfo(NClass scope,
                                   javax.xml.namespace.QName name)

Specified by:

getElementInfo in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

getElementMappings

public java.util.Map<javax.xml.namespace.QName,CElementInfo> getElementMappings(NClass scope)

Specified by:

getElementMappings in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

getAllElements

public java.lang.Iterable<? extends CElementInfo> getAllElements()

Specified by:

getAllElements in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

getSchemaComponent

public com.sun.xml.xsom.XSComponent getSchemaComponent()

Deprecated. Always return null. Perhaps you are interested in schemaComponent?

Description copied from interface: CCustomizable

If this model object is built from XML Schema, this property returns a schema component from which the model is built.

Specified by:

getSchemaComponent in interface CCustomizable

Returns:

null if the model is built from sources other than XML Schema (such as DTD.)

getLocator

public org.xml.sax.Locator getLocator()

Deprecated. No line number available for the "root" component.

Description copied from interface: CCustomizable

Gets the source location in the schema from which this model component is created.

Specified by:

getLocator in interface CCustomizable

Returns:

never null.

getCustomizations

public CCustomizations getCustomizations()

Gets the global customizations.

Specified by:

getCustomizations in interface CCustomizable

Returns:

can be an empty list but never be null. The returned list is read-only. Do not modify.

See Also:

Plugin.getCustomizationURIs()

getXmlNs

public java.util.Map<java.lang.String,java.lang.String> getXmlNs(java.lang.String namespaceUri)

Not implemented in the compile-time model.

Specified by:

getXmlNs in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

getSchemaLocations

public java.util.Map<java.lang.String,java.lang.String> getSchemaLocations()

Specified by:

getSchemaLocations in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

getElementFormDefault

public javax.xml.bind.annotation.XmlNsForm getElementFormDefault(java.lang.String nsUri)

Specified by:

getElementFormDefault in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

getAttributeFormDefault

public javax.xml.bind.annotation.XmlNsForm getAttributeFormDefault(java.lang.String nsUri)

Specified by:

getAttributeFormDefault in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

dump

public void dump(javax.xml.transform.Result out)

Specified by:

dump in interface TypeInfoSet<NType,NClass,java.lang.Void,java.lang.Void>

getPackage

public CClassInfoParent.Package getPackage(com.sun.codemodel.JPackage pkg)