com.aspc.DBObj.Internal

Class Link

java.lang.Object

com.aspc.DBObj.Internal.Link

Direct Known Subclasses:

InwardLink, OutwardLink

public abstract class Link
extends java.lang.Object

Link is a THREAD MODE: MULTI-THREADED shared

Since:

March 22, 2001, 1:52 PM

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
protected DBClassConcrete	baseClass the base class
protected DBField	baseField the base field

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Link() Constructors

Method Summary

Modifier and Type	Method and Description
protected boolean	compatibleClass(DBClassConcrete firstClass, DBClassConcrete secondClass) are the classes compatible ?
static Link	createLink(java.lang.String orgPath, VirtualDB layer, DBClassConcrete baseClass)
abstract boolean	equals(Link cmpLink)
DBField	findBaseField()
abstract java.lang.String	getAsciiDescription(DBClassConcrete defaultClass, Link nextLink, java.lang.String paramProcOption)
abstract java.lang.String	getAsciiDescription(DBClassConcrete defaultClass, Link nextLink, java.lang.String paramProcOption, DBObject base)
DBClassConcrete	getBaseClassConcrete()
DBField	getBaseField()
abstract java.lang.String	getBinaryDescription(DBClassConcrete defaultClass, Link nextLink)
abstract java.lang.String	getBinaryDescription(DBClassConcrete defaultClass, Link nextLink, DBObject base)
abstract FldParams	getParams() The parameters for this link
abstract DBObject	nextStep(DBObject base, boolean createMissingObjects, HintField hint)
abstract DBClassConcrete	nextStepClassConcrete()

Methods inherited from class java.lang.Object

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

Field Detail

baseClass

protected DBClassConcrete baseClass

the base class

baseField

protected DBField baseField

the base field

Constructor Detail

Link

protected Link()

Constructors

Method Detail

createLink

public static Link createLink(@Nonnull
                              java.lang.String orgPath,
                              @Nonnull
                              VirtualDB layer,
                              @Nonnull
                              DBClassConcrete baseClass)
                       throws InvalidLink

Parameters:

orgPath -

layer - the layer

baseClass - The base class

Returns:

the value

Throws:

InvalidLink

compatibleClass

protected final boolean compatibleClass(DBClassConcrete firstClass,
                                        DBClassConcrete secondClass)

are the classes compatible ?

Parameters:

firstClass - the first class

secondClass - the second class

Returns:

true if compatible.

getBaseClassConcrete

@CheckReturnValue
 @Nullable
public DBClassConcrete getBaseClassConcrete()

Returns:

the value

getBaseField

@Nullable
 @CheckReturnValue
public DBField getBaseField()

Returns:

the value

findBaseField

@Nonnull
 @CheckReturnValue
public DBField findBaseField()

Returns:

the value

equals

@CheckReturnValue
public abstract boolean equals(Link cmpLink)

Parameters:

cmpLink -

Returns:

the value

getAsciiDescription

@CheckReturnValue
 @Nonnull
public abstract java.lang.String getAsciiDescription(DBClassConcrete defaultClass,
                                                                                 Link nextLink,
                                                                                 java.lang.String paramProcOption)

Parameters:

defaultClass -

nextLink -

paramProcOption -

Returns:

the value

getBinaryDescription

@CheckReturnValue
 @Nonnull
public abstract java.lang.String getBinaryDescription(DBClassConcrete defaultClass,
                                                                                  Link nextLink)

Parameters:

defaultClass -

nextLink -

Returns:

the value

getAsciiDescription

@CheckReturnValue
 @Nonnull
public abstract java.lang.String getAsciiDescription(DBClassConcrete defaultClass,
                                                                                 Link nextLink,
                                                                                 java.lang.String paramProcOption,
                                                                                 DBObject base)

Parameters:

defaultClass -

nextLink -

paramProcOption -

base - the base object

Returns:

the value

getBinaryDescription

@CheckReturnValue
 @Nonnull
public abstract java.lang.String getBinaryDescription(DBClassConcrete defaultClass,
                                                                                  Link nextLink,
                                                                                  DBObject base)

Parameters:

defaultClass -

nextLink -

base - the base object

Returns:

the value

nextStep

@CheckReturnValue
 @Nullable
public abstract DBObject nextStep(DBObject base,
                                                               boolean createMissingObjects,
                                                               HintField hint)
                                                        throws java.lang.Exception

Parameters:

base - the base object

createMissingObjects -

hint - the hint

Returns:

the value

Throws:

java.lang.Exception - a serious problem

nextStepClassConcrete

@Nullable
 @CheckReturnValue
public abstract DBClassConcrete nextStepClassConcrete()

Returns:

the value

getParams

@CheckReturnValue
 @Nullable
public abstract FldParams getParams()

The parameters for this link

Returns:

the value