AbstractGraphComposer

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.ibm.commerce.foundation.server.services.dataaccess.AbstractGraphComposer

All Implemented Interfaces:

java.io.Serializable
```
public abstract class AbstractGraphComposer
extends java.lang.Object
implements java.io.Serializable
```
This abstract class allows component to merge, add or modify the final graph. The component-provided class specified in the Query Template must implements this interface and must have a default constructor. Note, that even though this class implements the java.io.Serializable interface, we do not recommend serializing an instance of this class. In the process of de-serialization the value of the selection criteria set by the setSelectionCriteria(SelectionCriteria aSelectionCriteria) method will be reset to null.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AbstractGraphComposer()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract commonj.sdo.DataObject`	`composeGraph(java.util.List graphs, java.lang.String rootPropertyName, java.lang.String entityIdentityPropertyName)` This method composes the final graph given a collection of graphs, represented by the list of root objects
`SelectionCriteria`	`getSelectionCriteria()` Returns the selection criteria.
`void`	`setSelectionCriteria(SelectionCriteria aSelectionCriteria)` Sets the selection criteria.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractGraphComposer
```
public AbstractGraphComposer()
```
- Method Detail
  - composeGraph
```
public abstract commonj.sdo.DataObject composeGraph(java.util.List graphs,
                                                    java.lang.String rootPropertyName,
                                                    java.lang.String entityIdentityPropertyName)
```
    This method composes the final graph given a collection of graphs, represented by the list of root objects
    
    Parameters:
    
    graphs - A collection root DataObject, each representing a graph
    
    rootPropertyName - The property name from the root DataObject to the entity DataObject
    
    entityIdentityPropertyName - The property name represents the identity of the entity DataObject
    
    Returns:
    
    DataObject This is the root object containing a collection of DataObjects in a graph format.
  - setSelectionCriteria
```
public void setSelectionCriteria(SelectionCriteria aSelectionCriteria)
```
    Sets the selection criteria. The selection criteria contains original query information from the caller.
    
    Parameters:
    
    aSelectionCriteria - The selection criteria
  - getSelectionCriteria
```
public SelectionCriteria getSelectionCriteria()
```
    Returns the selection criteria. The selection criteria contains the original query information from the caller.
    
    Returns:
    
    The selection criteria