com.goldencode.p2j.schema

Class EntityName

java.lang.Object

com.goldencode.p2j.schema.EntityName

public final class EntityName
extends java.lang.Object

Representation of a qualified Progress schema entity name, reflecting the qualified name hierarchy represented by the Progress language naming conventions for schema entity references. Possible permutations are:

    database.table.field
    database.table
    table.field
    database
    table
    field
 

where each part of a fully qualified name represents an entity which has a one-to-many relationship with the entity to its right (if any), and a one-to-one relationship with the entity to its left (if any).

The primary purpose of this class is to normalize entity names which may be fully qualified, partially qualified, or unqualified into an object which contains all parts of the entity name (even if this requires that some remain null).

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATABASE Constant indicating name represents a database
static int	FIELD Constant indicating name represents a field
private static ConversionStatus	LOG Logger.
private java.lang.String[]	names Array of database, table, and field parts of qualified entity name
static int	TABLE Constant indicating name represents a table

Constructor Summary

Constructors

Constructor and Description
EntityName(int type, java.lang.String name) Constructor which parses a qualified entity name into its constituent parts.

Method Summary

Modifier and Type	Method and Description
static int	getChildType(int type) Get the type (i.e., TABLE or FIELD) of the next part of the entity name (as read from left to right), given the type of a qualifier.
java.lang.String	getDatabase() Get the database qualifier part of the entity name.
java.lang.String	getField() Get the field part of the entity name.
java.lang.String	getPart(int type) Get the name for the specified part of the entity name.
java.lang.String	getTable() Get the table qualifier part of the entity name.
static java.lang.String	getTypeName(int type) Get the descriptive name of the specified entity type.
static boolean	hasChildType(int type) Establish whether type (presumably the type of an entity name qualifier) has an associated "child" type, as described by the getChildType(int) method description.
static void	main(java.lang.String[] args) Unit test driver for this class.
private void	parseName(int type, java.lang.String name) Parse a qualified entity name into its constituent parts.
java.lang.String	toString() Creates a string representation of a normalized entity name.
private static void	validateType(int type) Validate that type represents a valid entity name component type (i.e., is one of the type constants defined by this class).

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final ConversionStatus LOG

Logger.

DATABASE

public static final int DATABASE

Constant indicating name represents a database

See Also:

Constant Field Values

TABLE

public static final int TABLE

Constant indicating name represents a table

See Also:

Constant Field Values

FIELD

public static final int FIELD

Constant indicating name represents a field

See Also:

Constant Field Values

names

private final java.lang.String[] names

Array of database, table, and field parts of qualified entity name

Constructor Detail

EntityName

public EntityName(int type,
                  java.lang.String name)
           throws java.lang.IllegalArgumentException

Constructor which parses a qualified entity name into its constituent parts.

Parameters:

type - Constant indicating whether this object represents a database, table, or field.

name - Qualified or unqualified entity name to be parsed.

Throws:

java.lang.IllegalArgumentException - if type is not a valid type constant or if name does not conform to the accepted schema entity naming conventions.

Method Detail

getTypeName

public static java.lang.String getTypeName(int type)
                                    throws java.lang.IllegalArgumentException

Get the descriptive name of the specified entity type.

Parameters:

type - Constant indicating type: database, table, or field.

Returns:

Descriptive name of the type.

Throws:

java.lang.IllegalArgumentException

hasChildType

public static boolean hasChildType(int type)

Establish whether type (presumably the type of an entity name qualifier) has an associated "child" type, as described by the getChildType(int) method description.

Parameters:

type - Type of the qualifier using the type constants of this class.

Returns:

true if type is either DATABASE or TABLE.

Throws:

java.lang.IllegalArgumentException - if type is neither DATABASE nor TABLE.

See Also:

getChildType(int), DATABASE, TABLE, FIELD

getChildType

public static int getChildType(int type)
                        throws java.lang.IllegalArgumentException

Get the type (i.e., TABLE or FIELD) of the next part of the entity name (as read from left to right), given the type of a qualifier.

Parameters:

type - Type of the qualifier; must be DATABASE or TABLE.

Returns:

Type of the "child" of the qualifier type represented by the type argument. Will be TABLE if type is DATABASE; will be FIELD if type is TABLE.

Throws:

java.lang.IllegalArgumentException - if type is neither DATABASE nor TABLE.

See Also:

hasChildType(int), DATABASE, TABLE, FIELD

validateType

private static void validateType(int type)
                          throws java.lang.IllegalArgumentException

Validate that type represents a valid entity name component type (i.e., is one of the type constants defined by this class).

Parameters:

type - Type constant to test for validity.

Throws:

java.lang.IllegalArgumentException - if type is not one of the defined type constants.

See Also:

getChildType(int), DATABASE, TABLE, FIELD

getPart

public java.lang.String getPart(int type)

Get the name for the specified part of the entity name.

Parameters:

type - Constant indicating whether to return the database, table, or field portion of the name.

Returns:

The name part corresponding with type. May be null if this object does not contain the specified part.

getDatabase

public java.lang.String getDatabase()

Get the database qualifier part of the entity name.

Returns:

The database qualifier part of the entity name. May be null if this entity name has no database qualifier.

getTable

public java.lang.String getTable()

Get the table qualifier part of the entity name.

Returns:

The table qualifier part of the entity name. May be null if this entity name has no table qualifier, or if it does not represent a table.

getField

public java.lang.String getField()

Get the field part of the entity name.

Returns:

The field part of the entity name. May be null if this entity does not represent a field.

toString

public java.lang.String toString()

Creates a string representation of a normalized entity name. Some parts of the name may be null. This is used primarily for debug purposes.

Overrides:

toString in class java.lang.Object

Returns:

String representation of this object's internal state.

parseName

private void parseName(int type,
                       java.lang.String name)
                throws java.lang.IllegalArgumentException

Parse a qualified entity name into its constituent parts. This method normalizes all entity names -- whether fully qualified, partially qualified, or unqualified -- into a common format.

Parameters:

type - Constant indicating whether this object represents a database, table, or field.

name - Qualified or unqualified entity name to be parsed.

Throws:

java.lang.IllegalArgumentException - if type is not a valid type constant or if name does not conform to the accepted schema entity naming conventions.

main

public static void main(java.lang.String[] args)

Unit test driver for this class. Accepts an entity type and fully qualified, partially qualified, or unqualified entity name and prints the normalized form of the name.

Parameters:

args - Command line arguments:

1. Entity type (must use integer type constants)
2. Entity name string to be parsed