org.jlf.dataMap
Class RelationshipDescriptor

java.lang.Object
  |
  +--org.jlf.dataMap.RelationshipDescriptor

All Implemented Interfaces:

java.io.Serializable

public class RelationshipDescriptor

extends java.lang.Object

implements java.io.Serializable

This class is an abstract base class to help describe a relational database relationship. This relationship helps tie different business objects together in a manner where coders can simply describe the relationship instead of having to figure out how to hand-code each one.

See Also:

DataMappedObject, AggregationRelationshipDescriptor, AssociationRelationshipDescriptor, Relationship, Serialized Form

Field Summary

protected java.lang.Class	relationshipClass The DataMappedObject class on the other side of the relationship (role B in UML).
protected java.lang.String	relationshipName The name of the relationship so accessors can conveniently refer to the relationship.

Constructor Summary

protected	RelationshipDescriptor() Protect the default constructor, please use a paramterized constructor instead!
	RelationshipDescriptor(java.lang.String relationshipName, java.lang.Class relationshipClass) Constructs a new instance parameterized with the name and class of objects on the other side (role B) of the relationship.

Method Summary

java.lang.Class	getRelationshipClass() Getter for the relationshipClass.
java.lang.String	getRelationshipName() Getter for the relationshipName.

Methods inherited from class java.lang.Object

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

Field Detail

relationshipName

protected java.lang.String relationshipName

The name of the relationship so accessors can conveniently refer to the relationship.

relationshipClass

protected java.lang.Class relationshipClass

The DataMappedObject class on the other side of the relationship (role B in UML).

Constructor Detail

RelationshipDescriptor

protected RelationshipDescriptor()

Protect the default constructor, please use a paramterized constructor instead!

RelationshipDescriptor

public RelationshipDescriptor(java.lang.String relationshipName,
                              java.lang.Class relationshipClass)

Constructs a new instance parameterized with the name and class of objects on the other side (role B) of the relationship.

Parameters:

relationshipName - The name of the relationship being described

relationshipClass - The DataMappedObject class on the other side of the relationship (role B in UML)

Method Detail

getRelationshipName

public java.lang.String getRelationshipName()

Getter for the relationshipName.

Returns:

The relationshipName instance variable

getRelationshipClass

public java.lang.Class getRelationshipClass()

Getter for the relationshipClass.

Returns:

The relationshipClass instance variable