com.aspc.DBObj.Internal

Class InwardLink

java.lang.Object

com.aspc.DBObj.Internal.Link

com.aspc.DBObj.Internal.InwardLink

public class InwardLink
extends Link

InwardPath is a THREAD MODE: MULTI-THREADED

Since:

March 22, 2001, 1:47 PM

Author:

Nigel Leck

Field Summary

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

baseClass, baseField

Constructor Summary

Constructors

Constructor and Description
InwardLink(java.lang.String originalPath, VirtualDB layer, DBClassConcrete defaultBaseClass)

Method Summary

Modifier and Type	Method and Description
DBObject	createNewTarget(DBObject base)
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)
DBField	getInwardField()
DBClassConcrete	getInwardTargetClassConcrete()
FldParams	getParams() The parameters for this link
DBResult	getResult(DBObject base, HintField hint)
GlobalKey	getRow()
int	getRowOffset()
DBObject	nextStep(DBObject base, boolean createMissingObjects, HintField hint)
DBClassConcrete	nextStepClassConcrete()
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

InwardLink

public InwardLink(java.lang.String originalPath,
                  VirtualDB layer,
                  DBClassConcrete defaultBaseClass)
           throws InvalidLink

Parameters:

originalPath -

layer - the layer

defaultBaseClass -

Throws:

InvalidLink

Method Detail

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

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

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

toString

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

Overrides:

toString in class java.lang.Object

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

nextStepClassConcrete

@Nullable
 @CheckReturnValue
public DBClassConcrete nextStepClassConcrete()

Specified by:

nextStepClassConcrete in class Link

Returns:

the value

getResult

public DBResult getResult(DBObject base,
                          HintField hint)
                   throws java.lang.Exception

Parameters:

hint - hint of the other objects

base - the base object

Returns:

the value

Throws:

java.lang.Exception - a serious problem

nextStep

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

Specified by:

nextStep in class Link

Parameters:

base - the base object

createMissingObjects -

hint - the hint

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getRow

public GlobalKey getRow()

Returns:

the value

getRowOffset

public int getRowOffset()

Returns:

the value

getInwardTargetClassConcrete

public DBClassConcrete getInwardTargetClassConcrete()

Returns:

the value

getInwardField

public DBField getInwardField()

Returns:

the value

createNewTarget

@Nonnull
public DBObject createNewTarget(@Nonnull
                                         DBObject base)
                                  throws java.lang.Exception

Parameters:

base - the base object

Returns:

the value

Throws:

java.lang.Exception - a serious problem