Groovy Documentation

src.java.org.grails.xfire.aegis.type
Interface TypeMappingRegistry


interface TypeMappingRegistry

The TypeMappingRegistry provides access to the type mappings within XFire.

author:
Dan Diephouse
since:
Feb 18, 2004


Field Summary
java.lang.String ROLE

 
Method Summary
void clear()

Removes all registered TypeMappings and encodingStyleURIs from this TypeMappingRegistry.

TypeMapping createTypeMapping(boolean autoTypes)

Creates a new empty TypeMapping object.

TypeMapping createTypeMapping(java.lang.String parentEncodingStyleURI, boolean autoTypes)

Create a type mapping with the specified encodying style.

TypeMapping getDefaultTypeMapping()

Gets the registered default TypeMapping instance.

java.lang.String[] getRegisteredEncodingStyleURIs()

Returns a list of registered encodingStyle URIs in this TypeMappingRegistry instance.

TypeMapping getTypeMapping(java.lang.String encodingStyleURI)

Returns the registered TypeMapping for the specified encodingStyle URI.

TypeMapping register(java.lang.String encodingStyleURI, TypeMapping mapping)

void registerDefault(TypeMapping mapping)

boolean removeTypeMapping(TypeMapping mapping)

Removes a TypeMapping from the TypeMappingRegistry.

TypeMapping unregisterTypeMapping(java.lang.String encodingStyleURI)

Unregisters a TypeMapping instance, if present, from the specified encodingStyleURI.

 

Field Detail

ROLE

java.lang.String ROLE


 
Method Detail

clear

public void clear()
Removes all registered TypeMappings and encodingStyleURIs from this TypeMappingRegistry.


createTypeMapping

public TypeMapping createTypeMapping(boolean autoTypes)
Creates a new empty TypeMapping object.
return:
TypeMapping instance.


createTypeMapping

public TypeMapping createTypeMapping(java.lang.String parentEncodingStyleURI, boolean autoTypes)
Create a type mapping with the specified encodying style.
param:
parentEncodingStyleURI Encoding style of the parent TypeMapping specified as an URI
param:
autoTypes Should this mapping auto-generate types where possible
return:
TypeMapping instance


getDefaultTypeMapping

public TypeMapping getDefaultTypeMapping()
Gets the registered default TypeMapping instance. This method returns null if there is no registered default TypeMapping in the registry.
return:
The registered default TypeMapping instance or null.


getRegisteredEncodingStyleURIs

public java.lang.String[] getRegisteredEncodingStyleURIs()
Returns a list of registered encodingStyle URIs in this TypeMappingRegistry instance.
return:
Array of the registered encodingStyle URIs


getTypeMapping

public TypeMapping getTypeMapping(java.lang.String encodingStyleURI)
Returns the registered TypeMapping for the specified encodingStyle URI. If there is no registered TypeMapping for the specified encodingStyleURI, this method returns null.
param:
encodingStyleURI Encoding style specified as an URI
return:
TypeMapping for the specified encodingStyleURI or null


register

public TypeMapping register(java.lang.String encodingStyleURI, TypeMapping mapping)


registerDefault

public void registerDefault(TypeMapping mapping)


removeTypeMapping

public boolean removeTypeMapping(TypeMapping mapping)
Removes a TypeMapping from the TypeMappingRegistry. A TypeMapping is associated with 1 or more encodingStyleURIs. This method unregisters the specified TypeMapping instance from all associated encodingStyleURIs and then removes this TypeMapping instance from the registry.
param:
mapping TypeMapping to remove
return:
true if specified TypeMapping is removed from the TypeMappingRegistry; false if the specified TypeMapping was not in the TypeMappingRegistry


unregisterTypeMapping

public TypeMapping unregisterTypeMapping(java.lang.String encodingStyleURI)
Unregisters a TypeMapping instance, if present, from the specified encodingStyleURI.
param:
encodingStyleURI Encoding style specified as an URI
return:
TypeMapping instance that has been unregistered or null if there was no TypeMapping registered for the specified encodingStyleURI


 

Groovy Documentation