org.codehaus.xfire.aegis.type
Interface TypeMappingRegistry

All Known Implementing Classes:
DefaultTypeMappingRegistry

public interface TypeMappingRegistry

The TypeMappingRegistry provides access to the type mappings within XFire.

Since:
Feb 18, 2004
Author:
Dan Diephouse

Field Summary
static 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

static final java.lang.String ROLE
Method Detail

register

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

registerDefault

void registerDefault(TypeMapping mapping)

getDefaultTypeMapping

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

Returns:
The registered default TypeMapping instance or null.

getRegisteredEncodingStyleURIs

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

Returns:
Array of the registered encodingStyle URIs

getTypeMapping

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.

Parameters:
encodingStyleURI - Encoding style specified as an URI
Returns:
TypeMapping for the specified encodingStyleURI or null

createTypeMapping

TypeMapping createTypeMapping(boolean autoTypes)
Creates a new empty TypeMapping object.

Returns:
TypeMapping instance.

createTypeMapping

TypeMapping createTypeMapping(java.lang.String parentEncodingStyleURI,
                              boolean autoTypes)
Create a type mapping with the specified encodying style.

Parameters:
parentEncodingStyleURI - Encoding style of the parent TypeMapping specified as an URI
autoTypes - Should this mapping auto-generate types where possible
Returns:
TypeMapping instance

unregisterTypeMapping

TypeMapping unregisterTypeMapping(java.lang.String encodingStyleURI)
Unregisters a TypeMapping instance, if present, from the specified encodingStyleURI.

Parameters:
encodingStyleURI - Encoding style specified as an URI
Returns:
TypeMapping instance that has been unregistered or null if there was no TypeMapping registered for the specified encodingStyleURI

removeTypeMapping

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.

Parameters:
mapping - TypeMapping to remove
Returns:
true if specified TypeMapping is removed from the TypeMappingRegistry; false if the specified TypeMapping was not in the TypeMappingRegistry

clear

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



Copyright © 2004-2010. All Rights Reserved.