ListableUtil (BASE 3.19.10 API documentation)

java.lang.Object

net.sf.basedb.util.listable.ListableUtil

public class ListableUtil
extends Object

Utility class for working with Listable items.

Since:: 3.5
Author:: nicklas

Constructor Summary

Constructors

Constructor Description

ListableUtil()

Method Summary

Modifier and Type	Method	Description
`static List<Item>`	`getListableItems(Item item, SyncFilter.SourceItemTransform transform)`	Get all item types that can have the specified relation to the with the given item type.
`static SourceItemTransformerFactory`	`getTransformerFactory(Item targetItemType)`	Create a source item transformer factory that can transform items to the given target item type.
`static SourceItemTransformerFactory`	`getTransformerFactory(Item targetItemType, boolean includeChildrenThatPushToParent)`	Create a source item transformer factory that can transform items to the given target item type.

Methods inherited from class java.lang.Object

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

Constructor Details
- ListableUtil
  
  public ListableUtil()
Method Details
- getListableItems
  
  public static List<Item> getListableItems(Item item, SyncFilter.SourceItemTransform transform)
  
  Get all item types that can have the specified relation to the with the given item type. Depending on the transform parameter this return either the parent or child items or the item itself.
- getTransformerFactory
  
  public static SourceItemTransformerFactory getTransformerFactory(Item targetItemType)
  
  Create a source item transformer factory that can transform items to the given target item type. If no transformer factory exists, null is returned.
- getTransformerFactory
  
  public static SourceItemTransformerFactory getTransformerFactory(Item targetItemType, boolean includeChildrenThatPushToParent)
  
  Create a source item transformer factory that can transform items to the given target item type. If no transformer factory exists, null is returned. The 'includeChildrenThatPushToParent' parameter can be used for transforms that go from child to parent items, when the target is a SAMPLE or EXTRACT. When this flag is set, transformer will also include child items that have a subtype that have the ItemSubtype.getPushAnnotations() flag enabled in the final result.
  
  Since:
  
  3.19.5