org.andromda.core.translation.library
Class LibraryTranslation

java.lang.Object
  org.andromda.core.translation.library.LibraryTranslation

public class LibraryTranslation

extends Object

The LibraryTranslation object which is the intermediary object between the Library and the child Translation instances.

Author:

Chad Brandon

Constructor Summary

LibraryTranslation()

Method Summary

Library	getLibrary() Returns the Library that this LibraryTranslation belongs too.
String	getName() Gets the name of this LibraryTranslation.
String	getTemplate() Gets the path to the template for this instance.
String	getTranslationFragment(String name, String kind) Gets the current "translated" value of this fragmentName for resulting from the last processTranslation method
Translator	getTranslator() Gets the Translator instance that will perform processing of the template.
String	getVariable() Gets the variable name which is made available to the translation template.
void	handleTranslationFragment(String name, String kind, Object node) Calls the handlerMethod from a translation fragment.
Translation	processTranslation(Map templateContext) Processes the template belonging to this LibraryTranslation and returns the Translation objects.
void	setLibrary(Library library) Sets the Library to which this LibraryInstance belongs.
void	setName(String name) Sets the name.
void	setTemplate(String template) Sets the path to the template.
protected void	setTranslation(Reader translationInput) The processed translation template as a Reader.
void	setTranslator(String translatorClass) Sets the Translator class that will perform the translation processing.
void	setVariable(String variable) Sets the variable name which is made available to the translation template.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LibraryTranslation

public LibraryTranslation()

Method Detail

getName

public String getName()

Gets the name of this LibraryTranslation.

Returns:

String

setName

public void setName(String name)

Sets the name.

Parameters:

name -

getTemplate

public String getTemplate()

Gets the path to the template for this instance.

Returns:

String

setTemplate

public void setTemplate(String template)

Sets the path to the template.

Parameters:

template -

getLibrary

public Library getLibrary()

Returns the Library that this LibraryTranslation belongs too.

Returns:

Library

setLibrary

public void setLibrary(Library library)

Sets the Library to which this LibraryInstance belongs.

Parameters:

library -

getVariable

public String getVariable()

Gets the variable name which is made available to the translation template.

Returns:

the variable name.

setVariable

public void setVariable(String variable)

Sets the variable name which is made available to the translation template.

Parameters:

variable - the variable name.

setTranslator

public void setTranslator(String translatorClass)

Sets the Translator class that will perform the translation processing.

Parameters:

translatorClass - the class of the translator.

getTranslator

public Translator getTranslator()

Gets the Translator instance that will perform processing of the template.

Returns:

Translator

handleTranslationFragment

public void handleTranslationFragment(String name,
                                      String kind,
                                      Object node)

Calls the handlerMethod from a translation fragment. Each handle method must take a java.lang.String as the first argument (the body of the fragment from the translation template) and a java.lang.Object for the second argument (the node being parsed that we may need to retrieve any additional information from).

Parameters:

name - the name of the fragment to retrieve.

node - the node Object which from the parsed expression.

kind - the kind of the translation fragment to handle.

getTranslationFragment

public String getTranslationFragment(String name,
                                     String kind)

Gets the current "translated" value of this fragmentName for resulting from the last processTranslation method

Parameters:

name - the name of the fragment to retrieve.

kind - the kind or type of fragment to retrieve (this is the based on the expression type: body, inv, post, pre, etc).

Returns:

String the value of the translated fragment or null of one wasn't found with the specified name.

setTranslation

protected void setTranslation(Reader translationInput)

The processed translation template as a Reader.

Parameters:

translationInput -

processTranslation

public Translation processTranslation(Map templateContext)

Processes the template belonging to this LibraryTranslation and returns the Translation objects. If template hasn't been set (i.e. is null, then this method won't do anything but return a null value).

Parameters:

templateContext - any key/value pairs that should be passed to the TemplateEngine while processing the translation template.

Returns:

Translation the Translation created from the processing the translation template.

toString

public String toString()

See Also:

Object.toString()