com.vinculumtech.carrierwave.manager
Class Modify

java.lang.Object
  com.vinculumtech.carrierwave.manager.Modify

public final class Modify

extends java.lang.Object

The Modify class is the root of all modify functions initiated via CarrierWave and its client API.

Version:

$Id: //depot/carrierwave/src/server/com/vinculumtech/carrierwave/manager/Modify.java#50 $

Field Summary

static java.lang.String

REUSE_CONTAINER

Method Summary

protected static Imageable	modifyGraphFor(LookupFunction lookupFunction, java.util.Map foundImageables, GraphNode originNode, Image originImage)
protected static Imageable	modifyGraphFor(LookupFunction lookupFunction, java.util.Map foundImageables, GraphPlan graphPlan, Image originImage)
static Icon	modifyImageableGraphFor(GraphNode originNode, Image originImage)
static Icon	modifyImageableGraphFor(GraphPlan graphPlan, Image originImage) Creates or modifies the graph represented by the graph rooted by given Image instance and described by the given GraphPlan instance. Note that only the children described by the given GraphPlan will be consulted.
static Icon[]	modifyImageableGraphFor(GraphPlan graphPlan, ImageGraph imageGraph) Creates or modifies the graph represented by the given ImageGraph instance. It is expected that the given ImageGraph instance may have one or more origin Image instances in the List of origins (ImageGraph.getOriginImages()). Also note that if an Image instance in the ImageGraph is not an origin, and is not a child (at any depth) of any of the available origin Image instances, it will be ignored.
static Icon[]	modifyImageableGraphFor(GraphPlan graphPlan, LookupFunction lookupFunction, ImageGraph imageGraph)
static Imageable	modifyReturnImageableGraphFor(GraphPlan graphPlan, Image originImage) Creates or modifies the graph represented by the graph rooted by given Image instance.
static Image	modifySelectGraphFor(GraphPlan graphPlan, Image originImage) Creates a new or modifies an existing Imageable object graph rooted with the given originImage Image instance and described by the given GraphPlan instance.
static ImageGraph	modifySelectGraphFor(GraphPlan graphPlan, ImageGraph imageGraph) Creates or modifies the graph represented by the given ImageGraph instance, and returns an ImageGraph that represents the changes.

Methods inherited from class java.lang.Object

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

Field Detail

REUSE_CONTAINER

public static final java.lang.String REUSE_CONTAINER

See Also:

Constant Field Values

Method Detail

modifySelectGraphFor

public static final Image modifySelectGraphFor(GraphPlan graphPlan,
                                               Image originImage)
                                        throws GraphException

Creates a new or modifies an existing Imageable object graph rooted with the given originImage Image instance and described by the given GraphPlan instance. The resulting graph is returned.

Parameters:

graphPlan -

originImage -

Returns:

Throws:

GraphException

modifySelectGraphFor

public static final ImageGraph modifySelectGraphFor(GraphPlan graphPlan,
                                                    ImageGraph imageGraph)
                                             throws GraphException

Creates or modifies the graph represented by the given ImageGraph instance, and returns an ImageGraph that represents the changes.

Parameters:

imageGraph -

Returns:

Throws:

GraphException

modifyImageableGraphFor

public static final Icon[] modifyImageableGraphFor(GraphPlan graphPlan,
                                                   ImageGraph imageGraph)
                                            throws GraphException

Creates or modifies the graph represented by the given ImageGraph instance.
It is expected that the given ImageGraph instance may have one or more origin Image instances in the List of origins (ImageGraph.getOriginImages()).
Also note that if an Image instance in the ImageGraph is not an origin, and is not a child (at any depth) of any of the available origin Image instances, it will be ignored.

Parameters:

imageGraph -

Returns:

an array of Icon instances referencing the origin Imageable instances

Throws:

GraphException

modifyImageableGraphFor

public static final Icon[] modifyImageableGraphFor(GraphPlan graphPlan,
                                                   LookupFunction lookupFunction,
                                                   ImageGraph imageGraph)
                                            throws GraphException

Throws:

GraphException

modifyImageableGraphFor

public static final Icon modifyImageableGraphFor(GraphPlan graphPlan,
                                                 Image originImage)
                                          throws GraphException

Creates or modifies the graph represented by the graph rooted by given Image instance and described by the given GraphPlan instance.
Note that only the children described by the given GraphPlan will be consulted.

Parameters:

graphPlan -

originImage -

Returns:

Throws:

GraphException

modifyImageableGraphFor

public static final Icon modifyImageableGraphFor(GraphNode originNode,
                                                 Image originImage)
                                          throws GraphException

Throws:

GraphException

modifyReturnImageableGraphFor

public static final Imageable modifyReturnImageableGraphFor(GraphPlan graphPlan,
                                                            Image originImage)
                                                     throws GraphException

Creates or modifies the graph represented by the graph rooted by given Image instance.

Parameters:

originImage -

Returns:

the Imageable instance corresponding to the given originImage instance

Throws:

GraphException

modifyGraphFor

protected static final Imageable modifyGraphFor(LookupFunction lookupFunction,
                                                java.util.Map foundImageables,
                                                GraphPlan graphPlan,
                                                Image originImage)
                                         throws GraphPlanException,
                                                GraphException

Throws:

GraphPlanException

GraphException

modifyGraphFor

protected static final Imageable modifyGraphFor(LookupFunction lookupFunction,
                                                java.util.Map foundImageables,
                                                GraphNode originNode,
                                                Image originImage)
                                         throws GraphPlanException,
                                                GraphException

Throws:

GraphPlanException

GraphException