com.goldencode.p2j.schema

Class TableInfo

java.lang.Object

com.goldencode.p2j.schema.TableInfo

public class TableInfo
extends java.lang.Object

A read-only bean which exposes schema-related information associated with a database table which is referenced in source code.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	buffer Table's buffer name as indicated in source.
private java.lang.String	database Table's database logical name or alias.
private java.lang.String	qualified Fully qualified schema name of the table.
private int	recordType Table's token type.
private java.lang.String	signature Table signature associated with the table.

Constructor Summary

Constructors

Constructor and Description
TableInfo(java.lang.String signature, java.lang.String qualified, java.lang.String buffer, java.lang.String database, int recordType) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBuffer() Get the buffer name associated with the field.
java.lang.String	getDatabase() Get the logical database name or alias, if any, associated with the field.
java.lang.String	getQualified() Get the fully qualified schema name of the field.
int	getRecordType() Get the Progress parser token type of a table, temp-table, work-table, or buffer which contains the field.
java.lang.String	getSignature() Get the signature of the table in the schema.

Methods inherited from class java.lang.Object

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

Field Detail

signature

private final java.lang.String signature

Table signature associated with the table.

qualified

private final java.lang.String qualified

Fully qualified schema name of the table.

buffer

private final java.lang.String buffer

Table's buffer name as indicated in source.

database

private final java.lang.String database

Table's database logical name or alias.

recordType

private final int recordType

Table's token type.

Constructor Detail

TableInfo

TableInfo(java.lang.String signature,
          java.lang.String qualified,
          java.lang.String buffer,
          java.lang.String database,
          int recordType)

Constructor.

Parameters:

signature - Structural signature for the table.

qualified - Fully qualified schema name of the table.

buffer - Name of the buffer indicated by the table reference in source code.

database - Name of the database which contains the table, as specified by the table reference in source code, or looked up if the source reference was unqualified.

recordType - Token type of the table backing the buffer indicated by the table reference in source code.

Method Detail

getSignature

public java.lang.String getSignature()

Get the signature of the table in the schema.

Returns:

Table signature.

getQualified

public java.lang.String getQualified()

Get the fully qualified schema name of the field.

Returns:

Qualified field name.

getBuffer

public java.lang.String getBuffer()

Get the buffer name associated with the field.

Returns:

Buffer name.

getDatabase

public java.lang.String getDatabase()

Get the logical database name or alias, if any, associated with the field.

Returns:

The logical name of the database associated with the buffer associated with the field. An empty string is returned if the containing table is a temp- or work-table.

getRecordType

public int getRecordType()

Get the Progress parser token type of a table, temp-table, work-table, or buffer which contains the field. If the record containing the field is a buffer, the type of the backing record is returned. That is, a type of BUFFER is never returned, only the type of the record which backs the buffer.

Returns:

Record token type.