wt.epm.retriever
Class FamilyTableResult

java.lang.Object
  wt.epm.retriever.FamilyTableResult

All Implemented Interfaces:

PopulatableResult

public class FamilyTableResult

extends Object

implements PopulatableResult

Presents FamilyTableHelper results.

Field Summary

private Map	containedMap
private Map	familyMap
private Set	filterMap
private Map	genericMap
private FamilyTableHelper.IncompatibleSet[]	incompatibleFT
private Set	incompatibleMap
private Map	instanceMap
private static Log	log logging
private Map	variantMap
private Map	versionMap

Constructor Summary

FamilyTableResult()

FamilyTableResult(WTHashSet filterMap)

Method Summary

private void	addToMap(Map map, Collection c)
private void	debugPrint(String msg, Object obj)
EPMDocument[]	getAllInstances(EPMDocument generic) Returns an array of all instances of the given generic.
EPMContainedIn	getEPMContainedInLink(EPMDocument member) Returns EPMContainedIn link of the given member.
EPMVariantLink	getEPMVariantLink(EPMDocument instance) Returns EPMVariantLink of the given instance.
EPMDocument[]	getFamilyMembers(EPMDocument member) Returns family members.
EPMSepFamilyTable	getFTVersion(EPMDocument member) Returns a family table version object.
WTSet	getFTVersions(WTCollection members) Returns Set of FamilyTable objects for given collection of EPMDocuments.
EPMDocument	getGeneric(EPMDocument instance) Returns a generic.
EPMDocument[]	getGenerics(EPMDocument instance) Returns all generics of the given instance.
FamilyTableHelper.IncompatibleSet[]	getIncompatibleFT() Returns array of incompatible FT
EPMDocument[]	getInstances(EPMDocument generic) Returns an array of the instances which directly refer to the given generic.
private void	getInstances(List ret, EPMDocument generic)
EPMDocument	getTopGeneric(EPMDocument instance) Returns a top level generic.
boolean	isCompatibleResult() Returns true if the result does not contain incompatible members.
boolean	isIncompatibleMember(EPMDocument member) Returns true if the given object is incompatible member.
void	populate(WTCollection nodes, WTCollection links) Takes collections of traced objects and links to build a specific result structure.
void	setIncompatibleFT(FamilyTableHelper.IncompatibleSet[] incompatibleFT)

Methods inherited from class java.lang.Object

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

Field Detail

genericMap

private Map genericMap

instanceMap

private Map instanceMap

versionMap

private Map versionMap

familyMap

private Map familyMap

variantMap

private Map variantMap

containedMap

private Map containedMap

filterMap

private Set filterMap

incompatibleMap

private Set incompatibleMap

incompatibleFT

private FamilyTableHelper.IncompatibleSet[] incompatibleFT

log

private static Log log

logging

Constructor Detail

FamilyTableResult

public FamilyTableResult()

FamilyTableResult

public FamilyTableResult(WTHashSet filterMap)

Method Detail

populate

public void populate(WTCollection nodes,
                     WTCollection links)
              throws WTException

Takes collections of traced objects and links to build a specific result structure.

Specified by:

populate in interface PopulatableResult

Parameters:

nodes - Collection of families members and IncompatibleSets.

links - Collection of EPMVariantLink and EPMContainedIn. throws WTException

Throws:

WTException

getGeneric

public EPMDocument getGeneric(EPMDocument instance)

Returns a generic.

Parameters:

instance - EPMDocument.

getFTVersion

public EPMSepFamilyTable getFTVersion(EPMDocument member)

Returns a family table version object.

getFTVersions

public WTSet getFTVersions(WTCollection members)
                    throws WTException

Returns Set of FamilyTable objects for given collection of EPMDocuments. If collection is NULL returns ALL FamilyTable objects from the result

Parameters:

members - WTCollection or NULL

Returns:

WTSet

Throws:

WTException

getTopGeneric

public EPMDocument getTopGeneric(EPMDocument instance)

Returns a top level generic.

Parameters:

instance - EPMDocument.

getInstances

public EPMDocument[] getInstances(EPMDocument generic)

Returns an array of the instances which directly refer to the given generic.

Parameters:

generic - EPMDocument.

getAllInstances

public EPMDocument[] getAllInstances(EPMDocument generic)

Returns an array of all instances of the given generic.

Parameters:

generic - EPMDocument.

isIncompatibleMember

public boolean isIncompatibleMember(EPMDocument member)

Returns true if the given object is incompatible member.

getFamilyMembers

public EPMDocument[] getFamilyMembers(EPMDocument member)

Returns family members.

getGenerics

public EPMDocument[] getGenerics(EPMDocument instance)

Returns all generics of the given instance.

Parameters:

instance - EPMDocument.

isCompatibleResult

public boolean isCompatibleResult()

Returns true if the result does not contain incompatible members.

getEPMContainedInLink

public EPMContainedIn getEPMContainedInLink(EPMDocument member)

Returns EPMContainedIn link of the given member.

Parameters:

member - EPMDocument.

getEPMVariantLink

public EPMVariantLink getEPMVariantLink(EPMDocument instance)

Returns EPMVariantLink of the given instance.

Parameters:

instance - EPMDocument.

getIncompatibleFT

public FamilyTableHelper.IncompatibleSet[] getIncompatibleFT()

Returns array of incompatible FT

setIncompatibleFT

public void setIncompatibleFT(FamilyTableHelper.IncompatibleSet[] incompatibleFT)

addToMap

private void addToMap(Map map,
                      Collection c)

getInstances

private void getInstances(List ret,
                          EPMDocument generic)

debugPrint

private void debugPrint(String msg,
                        Object obj)