org.eobjects.metamodel.schema
Interface NamedStructure

All Superinterfaces:

HasName

All Known Subinterfaces:

Column, Schema, Table

All Known Implementing Classes:

AbstractColumn, AbstractSchema, AbstractTable, CompositeSchema, ImmutableColumn, ImmutableSchema, MutableColumn, MutableSchema, MutableTable

public interface NamedStructure
extends HasName

Super-interface for named structural types in a DataContext.

Author:

Kasper Sørensen

Method Summary

String	getName() Gets the name of this structure.
String	getQualifiedLabel() Gets a qualified label for later lookup.
String	getQuote() Gets an optional quote string that is used to enclose the name of this structure.
String	getQuotedName() Gets the name, including optional quotes, of this structure.

Method Detail

getName

String getName()

Gets the name of this structure.

Specified by:

getName in interface HasName

Returns:

The name of the structure

getQuote

String getQuote()

Gets an optional quote string that is used to enclose the name of this structure.

Returns:

A quote string used to enclose the name or null if none exists.

getQuotedName

String getQuotedName()

Gets the name, including optional quotes, of this structure.

Returns:

The name of the structure with added quote strings.

getQualifiedLabel

String getQualifiedLabel()

Gets a qualified label for later lookup. Typically this qualified label is formatted with a simple dot separator. For example, for a column a typical qualified label would be: "MY_SCHEMA.MY_TABLE.MY_COLUMN". The qualified label can be used as a unique identifier for the structure but is not necessarily directly transferable to SQL syntax.

Returns:

a qualified label