java.lang.Object

adql.translator.FunctionTranslatorWithPattern

All Implemented Interfaces:: FunctionTranslator

public class FunctionTranslatorWithPattern extends Object implements FunctionTranslator

A FunctionTranslator working with a translation pattern.

A translation pattern is a string with a syntax allowing to make references to function arguments. See TranslationPattern for details about the pattern syntax and examples.

Since:

2.0

See Also:

Field Summary

Fields

Modifier and Type

Field

Description

protected final String

pattern

Pattern to apply to translate a given ADQL function.
Constructor Summary

Constructors

Constructor

Description

FunctionTranslatorWithPattern(String translationPattern)

Create a FunctionTranslator with a translation pattern.
Method Summary

Modifier and Type

Method

Description

final String

getPattern()

Get the translation pattern used in this FunctionTranslator.

String

translate(ADQLFunction fct, ADQLTranslator caller)

Translate the given ADQL function into the language supported by the given translator.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- pattern
  
  protected final String pattern
  
  Pattern to apply to translate a given ADQL function.
Constructor Details
- FunctionTranslatorWithPattern
  
  public FunctionTranslatorWithPattern(String translationPattern) throws NullPointerException
  
  Create a FunctionTranslator with a translation pattern.
  
  Parameters:
  
  translationPattern - The translation pattern to use.
  
  Throws:
  
  NullPointerException - If the given pattern is NULL or empty.
Method Details
- getPattern
  
  public final String getPattern()
  
  Get the translation pattern used in this FunctionTranslator.
  
  Returns:
  
  The used translation pattern.
- translate
  
  public String translate(ADQLFunction fct, ADQLTranslator caller) throws TranslationException
  
  Description copied from interface: FunctionTranslator
  
  Translate the given ADQL function into the language supported by the given translator.
  VERY IMPORTANT: This function MUST NOT use ADQLTranslator.translate(ADQLFunction) to translate the given ADQLFunction. The given ADQLTranslator must be used ONLY to translate the function's parameters.
  
  Specified by:
  
  translate in interface FunctionTranslator
  
  Parameters:
  
  fct - The function to translate.
  
  caller - Translator to use in order to translate ONLY function parameters.
  
  Returns:
  
  The translation of this function into the language supported by the given translator, or NULL to let the calling translator apply a default translation.
  
  Throws:
  
  TranslationException - If the translation fails.

Class FunctionTranslatorWithPattern

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

pattern

Constructor Details

FunctionTranslatorWithPattern

Method Details

getPattern

translate