TranslatorSupport (Speedment 2.3.7 API)

java.lang.Object
- com.speedment.code.TranslatorSupport<DOC>

Type Parameters:

DOC - the document type
```
public final class TranslatorSupport<DOC extends Document & HasName & HasMainInterface>
extends Object
```
A support class for the Translator interface that holds various naming methods used in the translator implementations.
This class might be refactored later on to separate methods that require the document and those that do not in separate files.

Since:

2.3

Author:

Emil Forslund

Field Summary

Fields
Modifier and Type Field and Description

static String GENERATED_PACKAGE

static String GENERATED_PREFIX

static String IMPL_SUFFIX

static String MANAGER_SUFFIX

Fields
Modifier and Type	Field and Description
`static String`	`GENERATED_PACKAGE`
`static String`	`GENERATED_PREFIX`
`static String`	`IMPL_SUFFIX`
`static String`	`MANAGER_SUFFIX`

Constructor Summary

Constructors
Constructor and Description

TranslatorSupport(Speedment speedment, DOC document)

Constructors
Constructor and Description
`TranslatorSupport(Speedment speedment, DOC document)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`baseDirectoryName()` Returns the base directory name of the current node.
`String`	`basePackageName()` Returns the base package name of the current node.
`Optional<Column>`	`column()` Return this node or any ancestral node that is a `Column`.
`Column`	`columnOrThrow()` Return this node or any ancestral node that is a `Column`.
`Optional<Dbms>`	`dbms()` Return this node or any ancestral node that is a `Dbms`.
`Dbms`	`dbmsOrThrow()` Return this node or any ancestral node that is a `Dbms`.
`protected DOC`	`document()`
`String`	`entityImplName()`
`Type`	`entityImplType()`
`String`	`entityName()`
`Type`	`entityType()`
`String`	`fullyQualifiedTypeName()` Returns the fully qualified type name of the current document.
`String`	`fullyQualifiedTypeName(String subPath)` Returns the fully qualified type name of the current document.
`String`	`fullyQualifiedTypeName(String subPath, String filePrefix)` Returns the fully qualified type name of the current document.
`String`	`generatedEntityImplName()`
`Type`	`generatedEntityImplType()`
`String`	`generatedEntityName()`
`Type`	`generatedEntityType()`
`String`	`generatedManagerImplName()`
`Type`	`generatedManagerImplType()`
`String`	`generatedManagerName()`
`Type`	`generatedManagerType()`
`String`	`managerImplName()`
`Type`	`managerImplType()`
`String`	`managerName()`
`Type`	`managerType()`
`String`	`managerTypeName()` Returns the alias of the current document as a java type but with the keyword 'Manager' appended to it.
`String`	`managerTypeName(HasAlias doc)` Returns the alias of the specified document as a java type but with the keyword 'Manager' appended to it.
`JavaLanguageNamer`	`namer()`
`Optional<Project>`	`project()` Return this node or any ancestral node that is a `Project`.
`Project`	`projectOrThrow()` Return this node or any ancestral node that is a `Project`.
`Optional<Schema>`	`schema()` Return this node or any ancestral node that is a `Schema`.
`Schema`	`schemaOrThrow()` Return this node or any ancestral node that is a `Schema`.
`Speedment`	`speedment()`
`Optional<Table>`	`table()` Return this node or any ancestral node that is a `Table`.
`Table`	`tableOrThrow()` Return this node or any ancestral node that is a `Table`.
`String`	`typeName()` Returns the alias of the current document formatted as a java type.
`String`	`typeName(HasAlias doc)` Returns the alias of the specified document formatted as a java type.
`String`	`typeName(Project project)` Returns the name of the specified project formatted as a java type.
`String`	`variableName()` Returns the alias of the current document formatted as a java variable.
`String`	`variableName(HasAlias doc)` Returns the alias of the specified document formatted as a java variable.

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

- Field Detail
  - IMPL_SUFFIX
```
public static final String IMPL_SUFFIX
```
    See Also:
    
    Constant Field Values
  - MANAGER_SUFFIX
```
public static final String MANAGER_SUFFIX
```
    See Also:
    
    Constant Field Values
  - GENERATED_PACKAGE
```
public static final String GENERATED_PACKAGE
```
    See Also:
    
    Constant Field Values
  - GENERATED_PREFIX
```
public static final String GENERATED_PREFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TranslatorSupport
```
public TranslatorSupport(Speedment speedment,
                         DOC document)
```
- Method Detail
  - speedment
```
public Speedment speedment()
```
  - namer
```
public JavaLanguageNamer namer()
```
  - document
```
protected DOC document()
```
  - entityName
```
public String entityName()
```
  - entityImplName
```
public String entityImplName()
```
  - generatedEntityName
```
public String generatedEntityName()
```
  - generatedEntityImplName
```
public String generatedEntityImplName()
```
  - managerName
```
public String managerName()
```
  - managerImplName
```
public String managerImplName()
```
  - generatedManagerName
```
public String generatedManagerName()
```
  - generatedManagerImplName
```
public String generatedManagerImplName()
```
  - entityType
```
public Type entityType()
```
  - entityImplType
```
public Type entityImplType()
```
  - generatedEntityType
```
public Type generatedEntityType()
```
  - generatedEntityImplType
```
public Type generatedEntityImplType()
```
  - managerType
```
public Type managerType()
```
  - managerImplType
```
public Type managerImplType()
```
  - generatedManagerType
```
public Type generatedManagerType()
```
  - generatedManagerImplType
```
public Type generatedManagerImplType()
```
  - variableName
```
public String variableName()
```
    Returns the alias of the current document formatted as a java variable.
    Example:
    - employeesSchema
    - userTable
    - firstname
    Returns:
    
    the document name as a variable
    
    See Also:
    
    document()
  - variableName
```
public String variableName(HasAlias doc)
```
    Returns the alias of the specified document formatted as a java variable.
    Example:
    - employeesSchema
    - userTable
    - firstname
    Parameters:
    
    doc - the document to retrieve the name from.
    
    Returns:
    
    the node name as a variable
  - typeName
```
public String typeName()
```
    Returns the alias of the current document formatted as a java type.
    Example:
    - EmployeesSchema
    - UserTable
    - Firstname
    Returns:
    
    the document alias as a type
    
    See Also:
    
    document()
  - typeName
```
public String typeName(HasAlias doc)
```
    Returns the alias of the specified document formatted as a java type.
    Example:
    - EmployeesSchema
    - UserTable
    - Firstname
    Parameters:
    
    doc - the document to retrieve the alias from
    
    Returns:
    
    the document alias as a type
  - typeName
```
public String typeName(Project project)
```
    Returns the name of the specified project formatted as a java type.
    Example:
    - EmployeesSchema
    - UserTable
    - Firstname
    Parameters:
    
    project - the document to retrieve the name from
    
    Returns:
    
    the project name as a type
  - managerTypeName
```
public String managerTypeName()
```
    Returns the alias of the current document as a java type but with the keyword 'Manager' appended to it.
    Example:
    - EmployeesSchemaManager
    - UserTableManager
    - FirstnameManager
    Returns:
    
    the document alias as a manager type
    
    See Also:
    
    document()
  - managerTypeName
```
public String managerTypeName(HasAlias doc)
```
    Returns the alias of the specified document as a java type but with the keyword 'Manager' appended to it.
    Example:
    - EmployeesSchemaManager
    - UserTableManager
    - FirstnameManager
    Parameters:
    
    doc - the document to retrieve the alias from
    
    Returns:
    
    the document alias as a manager type
  - fullyQualifiedTypeName
```
public String fullyQualifiedTypeName()
```
    Returns the fully qualified type name of the current document.
    Example:
    - com.speedment.example.employeesschema.EmployeesSchema
    - com.speedment.example.usertable.UserTable
    - com.speedment.example.usertable.firstname.Firstname
    Note that this method is only meant to work with documents at Table or higher level in the hierarchy. It will return a result for all documents located in a valid hierarchy, but the result might not be as intended.
    Returns:
    
    the fully qualified type name of the current document
    
    See Also:
    
    Concerning fully qualified type names
  - fullyQualifiedTypeName
```
public String fullyQualifiedTypeName(String subPath)
```
    Returns the fully qualified type name of the current document. The specified sub-path will be added after the base package name and before the type name of the node. The sub-path should not contain either leading nor trailing dots.
    Example:
    - com.speedment.example.employeesschema.EmployeesSchema
    - com.speedment.example.usertable.UserTable
    - com.speedment.example.usertable.firstname.Firstname
    Note that this method is only meant to work with nodes at Table or higher level in the hierarchy. It will return a result for all documents located in a valid hierarchy, but the result might not be as intended.
    Parameters:
    
    subPath - A sub-path to be added at the end of the 'package'-part of the qualified type name. This value can be null and in that case an ordinary fullyQualifiedTypeName will be returned.
    
    Returns:
    
    the fully qualified type name of the current document
    
    See Also:
    
    Concerning fully qualified type names
  - fullyQualifiedTypeName
```
public String fullyQualifiedTypeName(String subPath,
                                     String filePrefix)
```
    Returns the fully qualified type name of the current document. The specified sub-path will be added after the base package name and before the type name of the node. The sub-path should not contain either leading nor trailing dots.
    Example:
    - com.speedment.example.employeesschema.EmployeesSchema
    - com.speedment.example.usertable.UserTable
    - com.speedment.example.usertable.firstname.Firstname
    Note that this method is only meant to work with nodes at Table or higher level in the hierarchy. It will return a result for all documents located in a valid hierarchy, but the result might not be as intended.
    Parameters:
    
    subPath - a prefix that will be added to the "class"-part of the type name
    
    filePrefix - a sub-path to be added at the end of the 'package'-part of the qualified type name. This value can be null and in that case an ordinary fullyQualifiedTypeName will be returned.
    
    Returns:
    
    the fully qualified type name of the current document
    
    See Also:
    
    Concerning fully qualified type names
  - basePackageName
```
public String basePackageName()
```
    Returns the base package name of the current node. This is everything up to but not including the type name. No trailing dot is added.
    
    Returns:
    
    the base package name in lowercase.
  - baseDirectoryName
```
public String baseDirectoryName()
```
    Returns the base directory name of the current node. It is the same as returned by basePackageName() but with dashes ('/') instead of dots ('.').
    
    Returns:
    
    the base package name.
  - project
```
public Optional<Project> project()
```
    Return this node or any ancestral node that is a Project. If no such node exists, an empty Optional is returned.
    
    Returns:
    
    the project node
  - dbms
```
public Optional<Dbms> dbms()
```
    Return this node or any ancestral node that is a Dbms. If no such node exists, an empty Optional is returned.
    
    Returns:
    
    the dbms node
  - schema
```
public Optional<Schema> schema()
```
    Return this node or any ancestral node that is a Schema. If no such node exists, an empty Optional is returned.
    
    Returns:
    
    the schema node
  - table
```
public Optional<Table> table()
```
    Return this node or any ancestral node that is a Table. If no such node exists, an empty Optional is returned.
    
    Returns:
    
    the table node
  - column
```
public Optional<Column> column()
```
    Return this node or any ancestral node that is a Column. If no such node exists, an empty Optional is returned.
    
    Returns:
    
    the column node
  - projectOrThrow
```
public Project projectOrThrow()
```
    Return this node or any ancestral node that is a Project. If no such node exists, an IllegalStateException is thrown.
    
    Returns:
    
    the project node
    
    Throws:
    
    IllegalStateException - if there was no project
  - dbmsOrThrow
```
public Dbms dbmsOrThrow()
```
    Return this node or any ancestral node that is a Dbms. If no such node exists, an IllegalStateException is thrown.
    
    Returns:
    
    the dbms node
    
    Throws:
    
    IllegalStateException - if there was no dbms
  - schemaOrThrow
```
public Schema schemaOrThrow()
```
    Return this node or any ancestral node that is a Schema. If no such node exists, an IllegalStateException is thrown.
    
    Returns:
    
    the schema node
    
    Throws:
    
    IllegalStateException - if there was no schema
  - tableOrThrow
```
public Table tableOrThrow()
```
    Return this node or any ancestral node that is a Table. If no such node exists, an IllegalStateException is thrown.
    
    Returns:
    
    the table node
    
    Throws:
    
    IllegalStateException - if there was no table
  - columnOrThrow
```
public Column columnOrThrow()
```
    Return this node or any ancestral node that is a Column. If no such node exists, an IllegalStateException is thrown.
    
    Returns:
    
    the column node
    
    Throws:
    
    IllegalStateException - if there was no column

Class TranslatorSupport<DOC extends Document & HasName & HasMainInterface>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IMPL_SUFFIX

MANAGER_SUFFIX

GENERATED_PACKAGE

GENERATED_PREFIX

Constructor Detail

TranslatorSupport

Method Detail

speedment

namer

document

entityName

entityImplName

generatedEntityName

generatedEntityImplName

managerName

managerImplName

generatedManagerName

generatedManagerImplName

entityType

entityImplType

generatedEntityType

generatedEntityImplType

managerType

managerImplType

generatedManagerType

generatedManagerImplType

variableName

variableName

typeName

typeName

typeName

managerTypeName

managerTypeName

fullyQualifiedTypeName

fullyQualifiedTypeName

fullyQualifiedTypeName

basePackageName

baseDirectoryName

project

dbms

schema

table

column

projectOrThrow

dbmsOrThrow

schemaOrThrow

tableOrThrow

columnOrThrow