com.aspc.DBObj.Internal

Class OutwardLink

java.lang.Object

com.aspc.DBObj.Internal.Link

com.aspc.DBObj.Internal.OutwardLink

Direct Known Subclasses:

LookupOutwardLink

public class OutwardLink
extends Link

Outward is a THREAD MODE: MULTI-THREADED

Since:

March 22, 2001, 1:49 PM

Author:

Nigel Leck

Field Summary

Fields inherited from class com.aspc.DBObj.Internal.Link

baseClass, baseField

Constructor Summary

Constructors

Constructor and Description
OutwardLink(java.lang.String pPath, VirtualDB layer, DBClassConcrete baseClass)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Link cmpLink)
java.lang.String	getAsciiDescription(DBClassConcrete defaultClass, Link nextLink, java.lang.String paramProcOption)
java.lang.String	getAsciiDescription(DBClassConcrete defaultClass, Link nextLink, java.lang.String paramProcOption, DBObject base)
java.lang.String	getBinaryDescription(DBClassConcrete defaultClass, Link nextLink)
java.lang.String	getBinaryDescription(DBClassConcrete defaultClass, Link nextLink, DBObject base)
FldParams	getParams() The parameters for this link
DBObject	nextStep(DBObject orgObject, boolean createMissingObjects, HintField hint) The next step in the path
DBClassConcrete	nextStepClassConcrete() The class of next link
java.lang.String	toString()

Methods inherited from class com.aspc.DBObj.Internal.Link

compatibleClass, createLink, findBaseField, getBaseClassConcrete, getBaseField

Methods inherited from class java.lang.Object

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

Constructor Detail

OutwardLink

public OutwardLink(java.lang.String pPath,
                   VirtualDB layer,
                   DBClassConcrete baseClass)
            throws InvalidLink

Parameters:

pPath - the path

layer - the layer

baseClass - the base class

Throws:

InvalidLink

Method Detail

equals

public boolean equals(Link cmpLink)

Specified by:

equals in class Link

Parameters:

cmpLink -

Returns:

the value

getAsciiDescription

public java.lang.String getAsciiDescription(DBClassConcrete defaultClass,
                                            Link nextLink,
                                            java.lang.String paramProcOption)

Specified by:

getAsciiDescription in class Link

Parameters:

defaultClass -

nextLink -

paramProcOption -

Returns:

the value

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAsciiDescription

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

Specified by:

getAsciiDescription in class Link

Parameters:

defaultClass -

nextLink -

paramProcOption -

base - the base object

Returns:

the value

getBinaryDescription

public java.lang.String getBinaryDescription(DBClassConcrete defaultClass,
                                             Link nextLink)

Specified by:

getBinaryDescription in class Link

Parameters:

defaultClass -

nextLink -

Returns:

the value

getBinaryDescription

public java.lang.String getBinaryDescription(DBClassConcrete defaultClass,
                                             Link nextLink,
                                             DBObject base)

Specified by:

getBinaryDescription in class Link

Parameters:

defaultClass -

nextLink -

base - the base object

Returns:

the value

getParams

@Nullable
 @CheckReturnValue
public FldParams getParams()

Description copied from class: Link

The parameters for this link

Specified by:

getParams in class Link

Returns:

the value

nextStepClassConcrete

@Nullable
 @CheckReturnValue
public DBClassConcrete nextStepClassConcrete()

The class of next link

Specified by:

nextStepClassConcrete in class Link

Returns:

the value

nextStep

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

The next step in the path

Specified by:

nextStep in class Link

Parameters:

orgObject -

createMissingObjects -

hint - the hint

Returns:

the value

Throws:

java.lang.Exception - a serious problem