org.codehaus.enunciate.apt
Class EnunciateFreemarkerModel

java.lang.Object
  freemarker.template.WrappingTemplateModel
      freemarker.template.SimpleHash
          net.sf.jelly.apt.freemarker.FreemarkerModel
              org.codehaus.enunciate.apt.EnunciateFreemarkerModel

All Implemented Interfaces:

freemarker.template.TemplateHashModel, freemarker.template.TemplateHashModelEx, freemarker.template.TemplateModel, java.io.Serializable

public class EnunciateFreemarkerModel
extends net.sf.jelly.apt.freemarker.FreemarkerModel

Author:

Ryan Heaton

See Also:

Serialized Form

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

EnunciateFreemarkerModel()

Method Summary

void	add(EndpointInterface ei) Add an endpoint interface to the model.
void	add(LocalElementDeclaration led)
void	add(Registry registry) Add an XML registry.
void	add(RootElementDeclaration rootElement) Add a root element to the model.
void	add(RootResource rootResource) Add a root resource to the model.
void	add(Schema schema) Adds a schema declaration to the model.
void	add(TypeDefinition typeDef) Add a type definition to the model.
void	addContentType(java.lang.String contentType) Add a content type.
void	addJAXRSProvider(com.sun.mirror.declaration.TypeDeclaration declaration) Add a JAX-RS provider to the model.
void	addJsonRootElement(JsonRootElementDeclaration rootElementDeclaration) Add a JSON root element to the model.
void	addJsonRootElement(RootElementDeclaration rootElement) Add a JSON root element to the model to reflect an XML root element being serialized as JSON with jackson.
protected void	addJsonSeeAlsoTypeDefinitions(com.sun.mirror.declaration.Declaration declaration) Add any type definitions that are referenced using XmlSeeAlso as JSON serializable types.
void	addJsonType(JsonTypeDefinition typeDefinition) Add a json type definition to the model.
java.lang.String	addNamespace(java.lang.String namespace) Add a namespace.
protected void	addReferencedJsonTypeDefinitions(com.sun.mirror.type.TypeMirror type) Adds any referenced type definitions for the specified type mirror.
protected void	addReferencedTypeDefinitions(Accessor accessor)
protected void	addReferencedTypeDefinitions(Attribute attribute) Add the type definition(s) referenced by the given attribute.
protected void	addReferencedTypeDefinitions(Element element) Add the referenced type definitions for the specified element.
protected void	addReferencedTypeDefinitions(EndpointInterface ei) Adds any type definitions referenced by an endpoint interface.
protected void	addReferencedTypeDefinitions(LocalElementDeclaration led) Adds the referenced type definitions for the specified local element declaration.
protected void	addReferencedTypeDefinitions(Registry registry) Add the referenced type definitions for a registry..
protected void	addReferencedTypeDefinitions(ResourceMethod resourceMethod) Add the referenced type definitions for the specified resource method.
protected void	addReferencedTypeDefinitions(RootElementDeclaration rootEl) Add any statically-referenced type definitions to the model.
protected void	addReferencedTypeDefinitions(com.sun.mirror.type.TypeMirror type) Adds any referenced type definitions for the specified type mirror.
protected void	addReferencedTypeDefinitions(Value value) Add the type definition(s) referenced by the given value.
protected void	addReferencedTypeDefinitions(WebFault webFault) Adds any type definitions referenced by a web fault.
protected void	addReferencedTypeDefinitions(WebMethod webMethod) Adds any type definitions referenced by a web method.
protected void	addSeeAlsoReference(com.sun.mirror.declaration.ClassDeclaration typeDeclaration) Add a "see also" reference.
protected void	addSeeAlsoTypeDefinitions(com.sun.mirror.declaration.Declaration declaration) Add any type definitions that are referenced using XmlSeeAlso.
protected TypeDefinition	createTypeDefinition(com.sun.mirror.declaration.ClassDeclaration declaration) Find the type definition for a class given the class's declaration.
protected java.lang.String	currentReferenceLocation() A descrition of the current reference location.
ElementDeclaration	findElementDeclaration(com.sun.mirror.declaration.ClassDeclaration declaration) Find the element declaration (local or global) for the specified declaration.
ResourceMethod	findExampleResourceMethod() Finds an example resource method, according to the following preference order: The first method annotated with DocumentationExample.
WebMethod	findExampleWebMethod() Finds an example resource method, according to the following preference order: The first method annotated with DocumentationExample.
JsonRootElementDeclaration	findJsonRootElementDeclaration(com.sun.mirror.declaration.ClassDeclaration declaration) Find the root JSON element declaration for the specified class.
JsonType	findJsonTypeDefinition(com.sun.mirror.declaration.ClassDeclaration declaration) Find the JSON type definition for a class given the class's declaration, or null if the class hasn't been added to the model.
JsonType	findJsonTypeDefinition(java.lang.String qualifiedName) Find the JSON type definition for a class given the class's qualified name, or null if the class hasn't been added to the model.
LocalElementDeclaration	findLocalElementDeclaration(com.sun.mirror.declaration.ClassDeclaration declaration) Finds the local element declaration for the specified class declaration.
RootElementDeclaration	findRootElementDeclaration(com.sun.mirror.declaration.ClassDeclaration declaration) Find the root element declaration for the specified class.
TypeDefinition	findTypeDefinition(com.sun.mirror.declaration.ClassDeclaration declaration) Find the type definition for a class given the class's declaration, or null if the class hasn't been added to the model.
protected java.lang.String	generatePrefix(java.lang.String namespace) Generate a prefix for the given namespace.
java.lang.String	getBaseDeploymentAddress() The base deployment address for the Enunciate application.
java.util.Map<java.lang.String,java.lang.String>	getContentTypesToIds() A map of content types to ids.
protected java.lang.String	getDefaultContentTypeId(java.lang.String contentType) Get the default content type id for the specified content type.
java.util.List<EndpointInterface>	getEndpointInterfaces() The list of endpoint interfaces.
EnunciateConfiguration	getEnunciateConfig() The enunciate configuration.
java.io.File	getFileOutputDirectory() The file output directory.
java.util.Map<java.lang.String,JsonSchemaInfo>	getIdsToJsonSchemas() A map of IDs to their associated JSON schema information.
protected ImplicitSchemaAttribute	getImplicitAttribute(Attribute attribute) Gets the implicit attribute for the specified attribute, or null if there is no implicit attribute.
protected ImplicitSchemaElement	getImplicitElement(Element element) Gets the implicit element for the specified element, or null if there is no implicit element.
java.util.List<com.sun.mirror.declaration.TypeDeclaration>	getJAXRSProviders() The list of JAX-RS providers.
XmlType	getKnownType(com.sun.mirror.type.DeclaredType declaredType) Gets the known type for the given declared type.
XmlType	getKnownType(com.sun.mirror.declaration.TypeDeclaration declaration) Gets the known type for the given declaration.
java.util.Map<java.lang.String,java.lang.String>	getNamespacesToPrefixes() A map of namespace URIs to their associated prefixes.
java.util.Map<java.lang.String,SchemaInfo>	getNamespacesToSchemas() A map of namespace URIs to their associated schema information.
java.util.Map<java.lang.String,WsdlInfo>	getNamespacesToWSDLs() A map of namespace URIs to their associated WSDL information.
java.util.List<RootElementDeclaration>	getRootElementDeclarations() The list of root element declarations found in the model.
java.util.List<RootResource>	getRootResources() The list of root resources.
java.util.List<TypeDefinition>	getTypeDefinitions() The list of type definitions found in the model.
java.io.File	getWadlFile() The wadl file for the model.
protected boolean	hasNeitherAttributesNorElements(org.codehaus.enunciate.apt.GenericTypeDefinition typeDef) Whether the specified type definition has neither attributes nor elements.
protected boolean	includeReferencedClasses() Whether to include referenced type definitions.
protected boolean	isComplexType(com.sun.mirror.declaration.TypeDeclaration declaration) A quick check to see if a declaration defines a complex schema type.
protected boolean	isEnumType(com.sun.mirror.declaration.TypeDeclaration declaration) A quick check to see if a declaration defines a enum schema type.
protected boolean	isKnownType(TypeDefinition typeDef) Whether the specified type is a known type.
protected boolean	isSimpleType(com.sun.mirror.declaration.TypeDeclaration declaration) A quick check to see if a declaration defines a simple schema type.
protected java.util.HashMap<java.lang.String,java.lang.String>	loadKnownContentTypes() Load the known content types (map of content type to id).
protected java.util.Map<java.lang.String,java.lang.String>	loadKnownNamespaces() Loads a map of known namespaces as keys to their associated prefixes.
protected java.util.Map<java.lang.String,XmlType>	loadKnownTypes() Loads the known types, keyed off the Java fqn.
protected com.sun.mirror.declaration.ClassDeclaration	narrowToAdaptingType(com.sun.mirror.declaration.ClassDeclaration declaration) Narrows the existing declaration down to its adapting declaration, if it's being adapted.
void	setBaseDeploymentAddress(java.lang.String baseDeploymentAddress) The base deployment address for the Enunciate application.
void	setEnunciateConfig(EnunciateConfiguration enunciateConfig) The enunciate configuration.
void	setFileOutputDirectory(java.io.File fileOutputDirectory) The file output directory.
void	setWadlFile(java.io.File wadlFile) The wadl file for the model.

Methods inherited from class net.sf.jelly.apt.freemarker.FreemarkerModel

get, getVariable, set, setVariable

Methods inherited from class freemarker.template.SimpleHash

copyMap, get, isEmpty, keys, put, put, putAll, remove, size, synchronizedWrapper, toMap, toString, values

Methods inherited from class freemarker.template.WrappingTemplateModel

getDefaultObjectWrapper, getObjectWrapper, setDefaultObjectWrapper, setObjectWrapper, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

EnunciateFreemarkerModel

public EnunciateFreemarkerModel()

Method Detail

loadKnownContentTypes

protected java.util.HashMap<java.lang.String,java.lang.String> loadKnownContentTypes()

Load the known content types (map of content type to id).

Returns:

The known content type.

loadKnownNamespaces

protected java.util.Map<java.lang.String,java.lang.String> loadKnownNamespaces()

Loads a map of known namespaces as keys to their associated prefixes.

Returns:

A map of known namespaces.

loadKnownTypes

protected java.util.Map<java.lang.String,XmlType> loadKnownTypes()

Loads the known types, keyed off the Java fqn.

Returns:

The map of known types, keyed off the Java fqn.

getNamespacesToPrefixes

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

A map of namespace URIs to their associated prefixes.

Returns:

A map of namespace URIs to their associated prefixes.

getContentTypesToIds

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

A map of content types to ids.

Returns:

A map of content types to ids.

getNamespacesToSchemas

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

A map of namespace URIs to their associated schema information.

Returns:

A map of namespace URIs to their associated schema information.

getNamespacesToWSDLs

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

A map of namespace URIs to their associated WSDL information.

Returns:

A map of namespace URIs to their associated WSDL information.

getIdsToJsonSchemas

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

A map of IDs to their associated JSON schema information.

Returns:

A map of IDs to their associated JSON schema information.

getRootResources

public java.util.List<RootResource> getRootResources()

The list of root resources.

Returns:

The list of root resources.

getJAXRSProviders

public java.util.List<com.sun.mirror.declaration.TypeDeclaration> getJAXRSProviders()

The list of JAX-RS providers.

Returns:

The list of JAX-RS providers.

add

public void add(EndpointInterface ei)

Add an endpoint interface to the model.

Parameters:

ei - The endpoint interface to add to the model.

includeReferencedClasses

protected boolean includeReferencedClasses()

Whether to include referenced type definitions.

Returns:

Whether to include referenced type definitions.

addJsonType

public void addJsonType(JsonTypeDefinition typeDefinition)

Add a json type definition to the model.

Parameters:

typeDefinition - The json type definition to add to the model.

add

public void add(TypeDefinition typeDef)

Add a type definition to the model.

Parameters:

typeDef - The type definition to add to the model.

currentReferenceLocation

protected java.lang.String currentReferenceLocation()

A descrition of the current reference location.

Returns:

A descrition of the current reference location.

isKnownType

protected boolean isKnownType(TypeDefinition typeDef)

Whether the specified type is a known type.

Parameters:

typeDef - The type def.

Returns:

Whether the specified type is a known type.

addReferencedTypeDefinitions

protected void addReferencedTypeDefinitions(Accessor accessor)

addReferencedTypeDefinitions

protected void addReferencedTypeDefinitions(Attribute attribute)

Add the type definition(s) referenced by the given attribute.

Parameters:

attribute - The attribute.

addReferencedTypeDefinitions

protected void addReferencedTypeDefinitions(Value value)

Add the type definition(s) referenced by the given value.

Parameters:

value - The value.

addReferencedTypeDefinitions

protected void addReferencedTypeDefinitions(Element element)

Add the referenced type definitions for the specified element.

Parameters:

element - The element.

getImplicitElement

protected ImplicitSchemaElement getImplicitElement(Element element)

Gets the implicit element for the specified element, or null if there is no implicit element.

Parameters:

element - The element.

Returns:

The implicit element, or null if none.

getImplicitAttribute

protected ImplicitSchemaAttribute getImplicitAttribute(Attribute attribute)

Gets the implicit attribute for the specified attribute, or null if there is no implicit attribute.

Parameters:

attribute - The attribute.

Returns:

The implicit attribute, or null if none.

add

public void add(RootResource rootResource)

Add a root resource to the model.

Parameters:

rootResource - The root resource to add to the model.

addReferencedTypeDefinitions

protected void addReferencedTypeDefinitions(ResourceMethod resourceMethod)

Add the referenced type definitions for the specified resource method.

Parameters:

resourceMethod - The resource method.

addJAXRSProvider

public void addJAXRSProvider(com.sun.mirror.declaration.TypeDeclaration declaration)

Add a JAX-RS provider to the model.

Parameters:

declaration - The declaration of the provider.

addJsonRootElement

public void addJsonRootElement(RootElementDeclaration rootElement)

Add a JSON root element to the model to reflect an XML root element being serialized as JSON with jackson.

Parameters:

rootElement - The root element to add.

addJsonRootElement

public void addJsonRootElement(JsonRootElementDeclaration rootElementDeclaration)

Add a JSON root element to the model.

Parameters:

rootElementDeclaration - The root element to add.

add

public void add(RootElementDeclaration rootElement)

Add a root element to the model.

Parameters:

rootElement - The root element to add.

addReferencedTypeDefinitions

protected void addReferencedTypeDefinitions(RootElementDeclaration rootEl)

Add any statically-referenced type definitions to the model.

Parameters:

rootEl - The root element.

addReferencedTypeDefinitions

protected void addReferencedTypeDefinitions(EndpointInterface ei)

Adds any type definitions referenced by an endpoint interface.

Parameters:

ei - The endpoint interface.

addReferencedTypeDefinitions

protected void addReferencedTypeDefinitions(WebMethod webMethod)

Adds any type definitions referenced by a web method.

Parameters:

webMethod - The web method.

addReferencedTypeDefinitions

protected void addReferencedTypeDefinitions(WebFault webFault)

Adds any type definitions referenced by a web fault.

Parameters:

webFault - The web fault.

addReferencedTypeDefinitions

protected void addReferencedTypeDefinitions(com.sun.mirror.type.TypeMirror type)

Adds any referenced type definitions for the specified type mirror.

Parameters:

type - The type mirror.

addReferencedJsonTypeDefinitions

protected void addReferencedJsonTypeDefinitions(com.sun.mirror.type.TypeMirror type)

Adds any referenced type definitions for the specified type mirror.

Parameters:

type - The type mirror.

addSeeAlsoTypeDefinitions

protected void addSeeAlsoTypeDefinitions(com.sun.mirror.declaration.Declaration declaration)

Add any type definitions that are referenced using XmlSeeAlso.

Parameters:

declaration - The declaration.

addSeeAlsoReference

protected void addSeeAlsoReference(com.sun.mirror.declaration.ClassDeclaration typeDeclaration)

Add a "see also" reference.

Parameters:

typeDeclaration - The reference.

addJsonSeeAlsoTypeDefinitions

protected void addJsonSeeAlsoTypeDefinitions(com.sun.mirror.declaration.Declaration declaration)

Add any type definitions that are referenced using XmlSeeAlso as JSON serializable types.

Parameters:

declaration - The declaration.

createTypeDefinition

protected TypeDefinition createTypeDefinition(com.sun.mirror.declaration.ClassDeclaration declaration)

Find the type definition for a class given the class's declaration.

Parameters:

declaration - The declaration.

Returns:

The type definition.

narrowToAdaptingType

protected com.sun.mirror.declaration.ClassDeclaration narrowToAdaptingType(com.sun.mirror.declaration.ClassDeclaration declaration)

Narrows the existing declaration down to its adapting declaration, if it's being adapted. Otherwise, the original declaration will be returned.

Parameters:

declaration - The declaration to narrow.

Returns:

The narrowed declaration.

isComplexType

protected boolean isComplexType(com.sun.mirror.declaration.TypeDeclaration declaration)

A quick check to see if a declaration defines a complex schema type.

Parameters:

declaration - The declaration to check.

Returns:

the value of the check.

isEnumType

protected boolean isEnumType(com.sun.mirror.declaration.TypeDeclaration declaration)

A quick check to see if a declaration defines a enum schema type.

Parameters:

declaration - The declaration to check.

Returns:

the value of the check.

isSimpleType

protected boolean isSimpleType(com.sun.mirror.declaration.TypeDeclaration declaration)

A quick check to see if a declaration defines a simple schema type.

Parameters:

declaration - The declaration to check.

Returns:

the value of the check.

hasNeitherAttributesNorElements

protected boolean hasNeitherAttributesNorElements(org.codehaus.enunciate.apt.GenericTypeDefinition typeDef)

Whether the specified type definition has neither attributes nor elements.

Parameters:

typeDef - The type def.

Returns:

Whether the specified type definition has neither attributes nor elements.

add

public void add(Registry registry)

Add an XML registry.

Parameters:

registry - The registry to add.

addReferencedTypeDefinitions

protected void addReferencedTypeDefinitions(Registry registry)

Add the referenced type definitions for a registry..

Parameters:

registry - The registry.

add

public void add(LocalElementDeclaration led)

addReferencedTypeDefinitions

protected void addReferencedTypeDefinitions(LocalElementDeclaration led)

Adds the referenced type definitions for the specified local element declaration.

Parameters:

led - The local element declaration.

add

public void add(Schema schema)

Adds a schema declaration to the model.

Parameters:

schema - The schema declaration to add to the model.

addNamespace

public java.lang.String addNamespace(java.lang.String namespace)

Add a namespace.

Parameters:

namespace - The namespace to add.

Returns:

The prefix for the namespace.

addContentType

public void addContentType(java.lang.String contentType)

Add a content type.

Parameters:

contentType - The content type to add.

getDefaultContentTypeId

protected java.lang.String getDefaultContentTypeId(java.lang.String contentType)

Get the default content type id for the specified content type.

Parameters:

contentType - The content type.

Returns:

The default content type id, or null if the content type is a wildcard type.

generatePrefix

protected java.lang.String generatePrefix(java.lang.String namespace)

Generate a prefix for the given namespace.

Parameters:

namespace - The namespace for which to generate a prefix.

Returns:

The prefix that was generated.

getKnownType

public XmlType getKnownType(com.sun.mirror.type.DeclaredType declaredType)

Gets the known type for the given declared type.

Parameters:

declaredType - The declared type.

Returns:

The known type for the given declared type, or null if the declared type is not known.

getKnownType

public XmlType getKnownType(com.sun.mirror.declaration.TypeDeclaration declaration)

Gets the known type for the given declaration.

Parameters:

declaration - The declaration.

Returns:

The known type for the given declaration, or null if the XML type of the declaration is not known.

findJsonTypeDefinition

public JsonType findJsonTypeDefinition(java.lang.String qualifiedName)

Find the JSON type definition for a class given the class's qualified name, or null if the class hasn't been added to the model.

Parameters:

qualifiedName - Qualified name of the class to find the JSON type for.

Returns:

The JSON type definition.

findJsonTypeDefinition

public JsonType findJsonTypeDefinition(com.sun.mirror.declaration.ClassDeclaration declaration)

Find the JSON type definition for a class given the class's declaration, or null if the class hasn't been added to the model.

Parameters:

declaration - The declaration.

Returns:

The JSON type definition.

findTypeDefinition

public TypeDefinition findTypeDefinition(com.sun.mirror.declaration.ClassDeclaration declaration)

Find the type definition for a class given the class's declaration, or null if the class hasn't been added to the model.

Parameters:

declaration - The declaration.

Returns:

The type definition.

findJsonRootElementDeclaration

public JsonRootElementDeclaration findJsonRootElementDeclaration(com.sun.mirror.declaration.ClassDeclaration declaration)

Find the root JSON element declaration for the specified class.

Parameters:

declaration - The class declaration

Returns:

The JSON root element declaration, or null if the declaration hasn't been added to the model.

findRootElementDeclaration

public RootElementDeclaration findRootElementDeclaration(com.sun.mirror.declaration.ClassDeclaration declaration)

Find the root element declaration for the specified class.

Parameters:

declaration - The class declaration

Returns:

The root element declaration, or null if the declaration hasn't been added to the model.

findLocalElementDeclaration

public LocalElementDeclaration findLocalElementDeclaration(com.sun.mirror.declaration.ClassDeclaration declaration)

Finds the local element declaration for the specified class declaration.

Parameters:

declaration - The declaration for which to find the local element declaration.

Returns:

The local element declaration, or null if none found.

findElementDeclaration

public ElementDeclaration findElementDeclaration(com.sun.mirror.declaration.ClassDeclaration declaration)

Find the element declaration (local or global) for the specified declaration.

Parameters:

declaration - The declaration.

Returns:

The element declaration, or null if none were found.

findExampleResourceMethod

public ResourceMethod findExampleResourceMethod()

Finds an example resource method, according to the following preference order:

1. The first method annotated with DocumentationExample.
2. The first method with BOTH an output payload with a known XML element and an input payload with a known XML element.
3. The first method with an output payload with a known XML element.

Returns:

An example resource method, or if no good examples were found.

findExampleWebMethod

public WebMethod findExampleWebMethod()

Finds an example resource method, according to the following preference order:

1. The first method annotated with DocumentationExample.
2. The first web method that returns a declared type.
3. The first web method.

Returns:

An example resource method, or if no good examples were found.

getTypeDefinitions

public java.util.List<TypeDefinition> getTypeDefinitions()

The list of type definitions found in the model.

Returns:

The list of type definitions found in the model.

getEndpointInterfaces

public java.util.List<EndpointInterface> getEndpointInterfaces()

The list of endpoint interfaces.

Returns:

The list of endpoint interfaces.

getRootElementDeclarations

public java.util.List<RootElementDeclaration> getRootElementDeclarations()

The list of root element declarations found in the model.

Returns:

The list of root element declarations found in the model.

getFileOutputDirectory

public java.io.File getFileOutputDirectory()

The file output directory.

Returns:

The file output directory.

setFileOutputDirectory

public void setFileOutputDirectory(java.io.File fileOutputDirectory)

The file output directory.

Parameters:

fileOutputDirectory - The file output directory.

getWadlFile

public java.io.File getWadlFile()

The wadl file for the model.

Returns:

The wadl file for the model.

setWadlFile

public void setWadlFile(java.io.File wadlFile)

The wadl file for the model.

Parameters:

wadlFile - The wadl file for the model.

getBaseDeploymentAddress

public java.lang.String getBaseDeploymentAddress()

The base deployment address for the Enunciate application.

Returns:

The base deployment address for the Enunciate application.

setBaseDeploymentAddress

public void setBaseDeploymentAddress(java.lang.String baseDeploymentAddress)

The base deployment address for the Enunciate application.

Parameters:

baseDeploymentAddress - The base deployment address for the Enunciate application.

getEnunciateConfig

public EnunciateConfiguration getEnunciateConfig()

The enunciate configuration.

Returns:

The enunciate configuration.

setEnunciateConfig

public void setEnunciateConfig(EnunciateConfiguration enunciateConfig)

The enunciate configuration.

Parameters:

enunciateConfig - The enunciate configuration.