er.rest
Class ERXRestNameRegistry

java.lang.Object
  er.rest.ERXRestNameRegistry

public class ERXRestNameRegistry
extends java.lang.Object

ERXNameRegistry provides a registry to remap the names of entities and keys to another name. ERXRestFormat applies these renames at parse and format time so that your code doesn't have to deal with it. The default routes also apply these naming rules, though the route variable that you use will be the internal name, not the external name.

Author:

mschrag

Constructor Summary

protected

ERXRestNameRegistry()

Method Summary

protected void	_setExternalNameForInternalName(java.lang.String externalName, java.lang.String internalName)
java.lang.String	externalNameForInternalName(java.lang.String internalName) Returns the external name for the given internal name.
java.lang.String	internalNameForExternalName(java.lang.String externalName) Returns the internal name for the given external name.
static ERXRestNameRegistry	registry() Returns the singleton name registry.
void	setExternalNameForInternalName(java.lang.String externalName, java.lang.String internalName) Sets the external name for a given internal name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXRestNameRegistry

protected ERXRestNameRegistry()

Method Detail

registry

public static ERXRestNameRegistry registry()

Returns the singleton name registry.

Returns:

the singleton name registry

setExternalNameForInternalName

public void setExternalNameForInternalName(java.lang.String externalName,
                                           java.lang.String internalName)

Sets the external name for a given internal name. For instance, if your entity is named "Person" but you want to display it as "Employee" in your service, you would setExternalNameForInternalName("Employee", "Person").

Parameters:

externalName - the name to expose in your service

internalName - the name for use internally

_setExternalNameForInternalName

protected void _setExternalNameForInternalName(java.lang.String externalName,
                                               java.lang.String internalName)

externalNameForInternalName

public java.lang.String externalNameForInternalName(java.lang.String internalName)

Returns the external name for the given internal name.

Parameters:

internalName - the internal name of the entity

Returns:

the external name of the entity

internalNameForExternalName

public java.lang.String internalNameForExternalName(java.lang.String externalName)

Returns the internal name for the given external name.

Parameters:

externalName - the external name of the entity

Returns:

the internal name of the entity