facets.core.superficial.app
Class IndexingTargeter

java.lang.Object
  facets.util.Tracer
      facets.core.superficial.TargeterCore
          facets.core.superficial.app.IndexingTargeter

All Implemented Interfaces:

Facetable, Notifiable, Notifying, SRetargetable, STargeter, Identified, Titled

Direct Known Subclasses:

AreaTargeter

public class IndexingTargeter
extends TargeterCore

FrameTargeter for an IndexingTarget.

IndexingTargeter defines much important behaviour used by AreaTargeter. In particular, it ensures that at each retargeting an appropriate targeter is either created or (more importantly) retrieved for retargeting to its target's indexed child; the criterion used being the TargeterCore.TargetType of the targeter returned by the child.

Construction is package-private; this class is defined public for documentation purposes only.

Nested Class Summary

Nested classes/interfaces inherited from class facets.core.superficial.TargeterCore

TargeterCore.TargetType

Nested classes/interfaces inherited from interface facets.core.superficial.Notifying

Notifying.Impact

Field Summary

Fields inherited from class facets.core.superficial.TargeterCore

targetType

Method Summary

protected boolean	blockNotification() Enables notification to be restricted to this member of the tree.
java.lang.Object	identity() Return an object that is as far as possible unique for the implementation.
Notifying.Impact	impact() Allows this Notifying to specify a default Notifying.Impact.
STargeter	indexedTargeter() Retargeted to IndexingTarget.indexedTarget() in the current target.
STargeter	indexing() Retargeted to IndexingTarget.indexing() in the current target.
Notifiable	monitor() The current Notifiable in the notification tree, as set with setMonitor.
protected TypedNode[]	newDebugChildren() Create a TypedNode[] representation of this Notifying for debug purposes.
protected static TypedNode	newDebugContentNode(java.lang.String title, java.lang.Object source)
protected static TypedNode	newDebugContentNode(java.lang.String title, java.lang.Object[] source)
protected static TypedNode	newDebugMonitorNode(Notifiable monitor)
TypedNode	newGraphNode() Returns a descriptive node for use in debug object graph.
void	notify(Notice notice) Respond to the Notice passed.
void	notifyMonitor(Notifying.Impact impact) Call notify on the parent monitor in the notification tree, typically with itself as parameter to the Notice passed.
void	retarget(STarget target, Notifying.Impact impact) Overrides superclass method.
protected STargeter	retargetedTargeter(STarget target, Notifying.Impact impact) Returns a targeter retargeted on the target passed.
void	retargetFacets(Notifying.Impact impact) Overrides superclass method.
void	setMonitor(Notifiable monitor) Attach the Notifying to a Notifiable parent in the notification tree.

Methods inherited from class facets.core.superficial.TargeterCore

attachFacet, elements, newRetargeted, target, title, toString, treeItems

Methods inherited from class facets.util.Tracer

trace, trace, trace, trace, trace, traceDebug, traceDebug, traceObjectText, traceOutput, traceOutputWithClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface facets.core.superficial.Notifying

impact, monitor, notifyMonitor, setMonitor

Methods inherited from interface facets.core.superficial.Notifiable

notify

Method Detail

indexedTargeter

public final STargeter indexedTargeter()

Retargeted to IndexingTarget.indexedTarget() in the current target.

indexing

public final STargeter indexing()

Retargeted to IndexingTarget.indexing() in the current target.

retarget

public void retarget(STarget target,
                     Notifying.Impact impact)

Overrides superclass method.

Creates and applies a targeter tree on the target tree headed by its IndexingTarget target.

Specified by:

retarget in interface SRetargetable

Specified by:

retarget in interface STargeter

Overrides:

retarget in class TargeterCore

See Also:

Notifying

retargetFacets

public void retargetFacets(Notifying.Impact impact)

Overrides superclass method.

Also calls retargetFacets(Notifying.Impact) in indexing() and indexedTargeter.

Specified by:

retargetFacets in interface Facetable

Specified by:

retargetFacets in interface STargeter

Overrides:

retargetFacets in class TargeterCore

retargetedTargeter

protected final STargeter retargetedTargeter(STarget target,
                                             Notifying.Impact impact)

Returns a targeter retargeted on the target passed.

The key method in managing variation in target type.

Parameters:

target - for targeter

impact -

Returns:

a targeter whose target type matches that of TargetCore.newTargeter() in target; this will generally have been stored during a previous retargeting.

newDebugChildren

protected TypedNode[] newDebugChildren()

Create a TypedNode[] representation of this Notifying for debug purposes.

Overrides:

newDebugChildren in class TargeterCore

newDebugContentNode

protected static final TypedNode newDebugContentNode(java.lang.String title,
                                                     java.lang.Object source)

newDebugContentNode

protected static final TypedNode newDebugContentNode(java.lang.String title,
                                                     java.lang.Object[] source)

newDebugMonitorNode

protected static final TypedNode newDebugMonitorNode(Notifiable monitor)

newGraphNode

public final TypedNode newGraphNode()

Returns a descriptive node for use in debug object graph.

impact

public Notifying.Impact impact()

Description copied from interface: Notifying

Allows this Notifying to specify a default Notifying.Impact.

Specified by:

impact in interface Notifying

Returns:

typically Notifying.Impact.DEFAULT

identity

public java.lang.Object identity()

Description copied from interface: Identified

Return an object that is as far as possible unique for the implementation.

This will usually be a class instance counter.

Specified by:

identity in interface Identified

monitor

public final Notifiable monitor()

The current Notifiable in the notification tree, as set with setMonitor.

Complains if no parent has been set.

Specified by:

monitor in interface Notifying

notify

public void notify(Notice notice)

Description copied from interface: Notifiable

Respond to the Notice passed.

When this method is called, the Notifiable should respond based on

• its own nature and state
• the Notice passed.

Specified by:

notify in interface Notifiable

notifyMonitor

public final void notifyMonitor(Notifying.Impact impact)

Description copied from interface: Notifying

Call notify on the parent monitor in the notification tree, typically with itself as parameter to the Notice passed.

Has no effect if no monitor has been set.

This is the usual means to trigger a surface retargeting, being called by an exposing SFacet on its target.

Specified by:

notifyMonitor in interface Notifying

Parameters:

impact - suggests the level of retargeting required

blockNotification

protected boolean blockNotification()

Enables notification to be restricted to this member of the tree.

Checked by notify(Notice); default returns false.

setMonitor

public final void setMonitor(Notifiable monitor)

Description copied from interface: Notifying

Attach the Notifying to a Notifiable parent in the notification tree.

Specified by:

setMonitor in interface Notifying