de.mguennewig.pobjects.metadata
Class Join

java.lang.Object
  de.mguennewig.pobjects.metadata.Join

public class Join
extends java.lang.Object

An implicit Column that joins two tables. Its type specifies how the data of the child table is interpreted from the point of view of the parent table.

Field Summary

static int	GET_METHOD Name of the Java method that returns the wrapper object of the indicated join.
static int	MEMBER_ATTR Name of the public Java member that holds a reference to the join descriptor.
static int	MEMBER_ATTR_TYPE Name of the public Java member that holds a reference to the descriptor's type.

Constructor Summary

Join(java.lang.String name, JoinType type, java.lang.String label, java.lang.String shortLabel)
Creates a new field.

Method Summary

Description	getDescription()
java.lang.String	getLabel()
java.lang.String	getName()
java.lang.String	getShortLabel()
JoinType	getType()
java.lang.String	name(int variant)
void	setDescription(Description descr)

Methods inherited from class java.lang.Object

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

Field Detail

GET_METHOD

public static final int GET_METHOD

Name of the Java method that returns the wrapper object of the indicated join.

See Also:

Constant Field Values

MEMBER_ATTR

public static final int MEMBER_ATTR

Name of the public Java member that holds a reference to the join descriptor.

See Also:

Constant Field Values

MEMBER_ATTR_TYPE

public static final int MEMBER_ATTR_TYPE

Name of the public Java member that holds a reference to the descriptor's type. The member's type is the most specific extension of the base type JoinType that applies.

See Also:

Constant Field Values

Constructor Detail

Join

public Join(java.lang.String name,
            JoinType type,
            java.lang.String label,
            java.lang.String shortLabel)

Creates a new field.

Parameters:

name - The column name, as seen by the application.

type - Specifies the kind of join.

label - String used to refer to this attribute in the user interface.

shortLabel - Abbreviated version of label. Typically used as header in the table view of a list of objects, where the table head is a list of shortLabel names.

Method Detail

getName

public final java.lang.String getName()

getDescription

public final Description getDescription()

setDescription

public final void setDescription(Description descr)

getLabel

public final java.lang.String getLabel()

getShortLabel

public final java.lang.String getShortLabel()

getType

public final JoinType getType()

name

public java.lang.String name(int variant)