Expander (Technia Value Components (2016.1.0) API Documentation

java.lang.Object
- com.technia.tvc.core.db.Expander

public class Expander
extends java.lang.Object

Convenient class for constructing expand calls on business objects.

Expample use of this class is shown below:

 Expander.Result result = Expander.create(objectId)
     .expandFrom()
     .expandFully()
     .typePattern()
         .add("type_Part")
         .add("type_DOCUMENTS")
         .done()
     .relPattern()
         .add("relationship_EBOM")
         .add("relationship_ReferenceDocument")
         .add("relationship_PartSpecification")
         .done()
     .objectWhere()
         .startSubExpr()
             .add("current != Obsolete")
             .and()
             .add("current != Release")
             .endSubExpr()
         .or()
             .startSubExpr()
                 .add("policy == 'EC Part'")
                 .or()
                 .add("policy == 'Development Part'")
             .endSubExpr()
         .done()
     .objectSelects()
         .add("id", "type", "name", "revision", "current", "policy")
         .addAttribute("attribute_Weight")
         .addAttribute("attribute_Classification")
         .done()
     .relSelects()
         .add("id", "type")
         .addAttribute("attribute_FindNumber")
         .addAttribute("attribute_ReferenceDesignator")
         .done()
     .perform();
 for (Expander.Row row : result) {
     String objectId = row.objectSelect(0);
     String weight = row.objectSelect(6);
     ...
     String relId = row.relSelect(0);
     String relType = row.relSelect(1);
     String fn = row.relSelect(2);
     String refDes = row.relSelect(3);
     ...
 }
 result.close();

Since:: 2010.1.1

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`Expander.Pattern`
`static class`	`Expander.Result`
`static class`	`Expander.Row`
`class`	`Expander.Selects`
`class`	`Expander.Where`

Method Summary

Methods
Modifier and Type	Method and Description
`static Expander`	`create(java.lang.String objectId)` Creates a new `Expander` instance.
`Expander`	`expandFully()` Sets the expand depth to 0 (e.g.
`Expander`	`expandInBothDirections()` Shorthand method for setting both expand from and expand to to TRUE.
`Expander`	`expandInFromDirection()` Shorthand method for setting the expand FROM to true and expand TO to false.
`Expander`	`expandInToDirection()` Shorthand method for setting the expand TO to true and expand FROM to false.
`Expander`	`expandOneLevel()` Sets the expand depth to 1.
`Expander`	`expandTo(int expandDepth)` Sets the expand depth to the specified value.
`Expander`	`expandTo(short expandDepth)` Sets the expand depth to the specified value.
`Expander`	`objectSelect(java.lang.String... select)`
`Expander`	`objectSelect(java.lang.String select)`
`Expander`	`objectSelect(matrix.util.StringList sl)`
`Expander.Selects`	`objectSelects()`
`Expander.Where`	`objectWhere()`
`Expander`	`objectWhere(java.lang.String whereExpression)`
`Expander.Result`	`perform()` Performs the expansion and encapsulates the result in a convenient wrapper around the selected data.
`StructureUtils.Node`	`perform(StructureUtils.NodeFactory factory)` Performs the expansion and encapsulates the structure into a corresponding Java object structure, where the nodes are built up with the provided `factory`
`Expander`	`rel(java.lang.String... item)` Adds an arbitrary amount of relationship types to the relationship pattern.
`Expander`	`rel(SymbolicName... item)` Adds an arbitrary amount of relationship types to the relationship pattern.
`Expander.Pattern`	`relPattern()`
`Expander`	`relSelect(java.lang.String... select)`
`Expander`	`relSelect(java.lang.String select)`
`Expander`	`relSelect(matrix.util.StringList sl)`
`Expander.Selects`	`relSelects()`
`Expander.Where`	`relWhere()`
`Expander`	`relWhere(java.lang.String whereExpression)`
`void`	`reset()` Resets this expander and makes it reusable for new expansions.
`Expander`	`setCheckHidden(boolean checkHidden)` Controls if you want the expansion logic to check for hidden types.
`Expander`	`setExpandDirection(boolean from, boolean to)` Specifies the expansion direction.
`Expander`	`setLimit(int limit)` Specifies the expand limit, e.g.
`Expander`	`setLimit(short limit)` Specifies the expand limit, e.g.
`Expander`	`setPageSize(int pageSize)` Specifies the page size when using an expansion iterator.
`Expander`	`setUseExpansionIterator(boolean useExpansionIterator)` Specifies if we should use an expansion iterator when performing the expansion, or if we should use the traditional expand-select.
`java.lang.String`	`toString()`
`Expander`	`type(java.lang.String... item)` A convenient method for adding business object types to the type pattern.
`Expander`	`type(SymbolicName... item)` A convenient method for adding business object types to the type pattern.
`Expander.Pattern`	`typePattern()`

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

- Method Detail
  - create
```
public static Expander create(java.lang.String objectId)
```
    Creates a new Expander instance.
    
    Parameters:
    objectId - The id of the object that you intend to expand.
    
    Returns:
    A new expander initialized with the given root object.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the objectId argument is null.
    Since:
    
    2010.1.1
  - reset
```
public void reset()
```
    Resets this expander and makes it reusable for new expansions.
    The objectId is of course same as when you created the expander, however, any where expression or select statement are removed. The expand depth and find limit are both set to -1. The page size is set to 100.
    From is set to true, while to is set to false.
    Check hidden is set to true.
    
    Since:
    
    2011.2.0
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setUseExpansionIterator
```
public Expander setUseExpansionIterator(boolean useExpansionIterator)
```
    Specifies if we should use an expansion iterator when performing the expansion, or if we should use the traditional expand-select.
    
    Parameters:
    useExpansionIterator - True if you want to use it.
    
    Returns:
    The Expander
    Since:
    
    2011.2.0
  - setPageSize
```
public Expander setPageSize(int pageSize)
```
    Specifies the page size when using an expansion iterator.
    The default page size is 100 if not specified.
    
    Parameters:
    pageSize - The page size.
    
    Returns:
    The Expander
    Since:
    
    2011.2.0
  - setCheckHidden
```
public Expander setCheckHidden(boolean checkHidden)
```
    Controls if you want the expansion logic to check for hidden types.
    
    Parameters:
    checkHidden - True to check hidden types, false to return hidden types.
    
    Returns:
    The Expander
    Since:
    
    2011.2.0
  - setLimit
```
public Expander setLimit(int limit)
```
    Specifies the expand limit, e.g. how many items to return from the expansion.
    
    Parameters:
    limit - The expand limit
    
    Returns:
    The Expander
    Since:
    
    2010.2.0
  - setLimit
```
public Expander setLimit(short limit)
```
    Specifies the expand limit, e.g. how many items to return from the expansion.
    
    Parameters:
    limit - The expand limit
    
    Returns:
    The Expander
    Since:
    
    2011.2.0
  - setExpandDirection
```
public Expander setExpandDirection(boolean from,
                          boolean to)
```
    Specifies the expansion direction. Note that if you expand in both to and from direction, the level cannot be "all".
    
    Parameters:
    from - True if to expand in the FROM direction, false to not do so.
    to - True if to expand in the TO direction, false to not do so.
    
    Returns:
    The Expander
    Since:
    
    2010.1.1
  - expandInFromDirection
```
public Expander expandInFromDirection()
```
    Shorthand method for setting the expand FROM to true and expand TO to false.
    
    Returns:
    The Expander
    Since:
    
    2010.1.1
  - expandInToDirection
```
public Expander expandInToDirection()
```
    Shorthand method for setting the expand TO to true and expand FROM to false.
    
    Returns:
    The Expander
    Since:
    
    2010.1.1
  - expandInBothDirections
```
public Expander expandInBothDirections()
```
    Shorthand method for setting both expand from and expand to to TRUE.
    
    Returns:
    The Expander
    Since:
    
    2010.1.1
  - expandOneLevel
```
public Expander expandOneLevel()
```
    Sets the expand depth to 1.
    
    Returns:
    The Expander
  - expandFully
```
public Expander expandFully()
```
    Sets the expand depth to 0 (e.g. all).
    
    Returns:
    The Expander
  - expandTo
```
public Expander expandTo(short expandDepth)
```
    Sets the expand depth to the specified value. A value of 0 indicates expand fully.
    
    Parameters:
    expandDepth - The depth
    
    Returns:
    The Expander
  - expandTo
```
public Expander expandTo(int expandDepth)
```
    Sets the expand depth to the specified value. A value of 0 indicates expand fully.
    
    Parameters:
    expandDepth - The depth
    
    Returns:
    The Expander
  - typePattern
```
public Expander.Pattern typePattern()
```
    Returns:
    The type pattern instance, which can be used to populate the business object types to include in the expansion.
  - type
```
public Expander type(java.lang.String... item)
```
    A convenient method for adding business object types to the type pattern.
    
    Parameters:
    item - The types to be added. Can be either real names or symbolic names.
    
    Returns:
    The Expander.
  - type
```
public Expander type(SymbolicName... item)
```
    A convenient method for adding business object types to the type pattern.
    
    Parameters:
    item - The types to be added.
    
    Returns:
    The Expander.
  - relPattern
```
public Expander.Pattern relPattern()
```
    Returns:
    The relationship type pattern instance, which can be used to populate the relationship types to include in the expansion.
  - rel
```
public Expander rel(java.lang.String... item)
```
    Adds an arbitrary amount of relationship types to the relationship pattern.
    
    Parameters:
    item - The relationship types to be added.
    
    Returns:
    The Expander
  - rel
```
public Expander rel(SymbolicName... item)
```
    Adds an arbitrary amount of relationship types to the relationship pattern.
    
    Parameters:
    item - The relationship types to be added.
    
    Returns:
    The Expander
  - objectSelects
```
public Expander.Selects objectSelects()
```
    Returns:
    The object select statements instance.
  - relSelects
```
public Expander.Selects relSelects()
```
    Returns:
    The relationship select statements instance.
  - objectSelect
```
public Expander objectSelect(java.lang.String select)
```
  - objectSelect
```
public Expander objectSelect(java.lang.String... select)
```
  - objectSelect
```
public Expander objectSelect(matrix.util.StringList sl)
```
  - relSelect
```
public Expander relSelect(java.lang.String select)
```
  - relSelect
```
public Expander relSelect(java.lang.String... select)
```
  - relSelect
```
public Expander relSelect(matrix.util.StringList sl)
```
  - objectWhere
```
public Expander.Where objectWhere()
```
  - objectWhere
```
public Expander objectWhere(java.lang.String whereExpression)
```
  - relWhere
```
public Expander.Where relWhere()
```
  - relWhere
```
public Expander relWhere(java.lang.String whereExpression)
```
  - perform
```
public StructureUtils.Node perform(StructureUtils.NodeFactory factory)
                            throws TVCException
```
    Performs the expansion and encapsulates the structure into a corresponding Java object structure, where the nodes are built up with the provided factory
    
    Parameters:
    factory - The factory used to convert the object/connection into a Java object.
    
    Returns:
    The top level node.
    
    Throws:
    
    TVCException - Upon failure when expanding the structure.
    Since:
    
    2010.1.1
  - perform
```
public Expander.Result perform()
                        throws TVCException
```
    Performs the expansion and encapsulates the result in a convenient wrapper around the selected data.
    
    Returns:
    The result
    
    Throws:
    
    TVCException - Upon failure when expanding the structure
    Since:
    
    2010.1.1

Class Expander

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

reset

toString

setUseExpansionIterator

setPageSize

setCheckHidden

setLimit

setLimit

setExpandDirection

expandInFromDirection

expandInToDirection

expandInBothDirections

expandOneLevel

expandFully

expandTo

expandTo

typePattern

type

type

relPattern

rel

rel

objectSelects

relSelects

objectSelect

objectSelect

objectSelect

relSelect

relSelect

relSelect

objectWhere

objectWhere

relWhere

relWhere

perform

perform