wt.epm.retriever
Class FamilyTableHelper

java.lang.Object
  wt.epm.retriever.FamilyTableHelper

All Implemented Interfaces:

EPMRetrieverConstants

public class FamilyTableHelper

extends Object

implements EPMRetrieverConstants

Nested Class Summary

static class

FamilyTableHelper.IncompatibleSet

Field Summary

private static String	CHECKPOINT_ALIAS
private static String	CONTAINEDIN_LINKS
(package private) WTContainer	container
private static String	FAMILIES
(package private) boolean	filterInstancesByInput
(package private) Folder	folder
private static String	GENERICS
(package private) WTCollection	input
(package private) boolean	isInputFromWorkspace
(package private) Class	iterCl
(package private) Class	linkCl
private static Log	log logging
private static String	MASTER_ID
(package private) Class	masterCl
(package private) Class	memberCl
private static String	MEMBERS
private static String	VARIANT_LINKS
(package private) EPMWorkspace	ws
(package private) Class	wsCl

Fields inherited from interface wt.epm.retriever.EPMRetrieverConstants

ALL_ASSOCIATED, ALL_ATTRIBUTES, ALL_DEPENDENTS, ALL_DRAWINGS, ALL_FT_MEMBERS, ASSOCIATED_OF_SEEDS, BACKWARD_ORDER, DEFAULT_ALIAS, DEFAULT_BLOCK_ALIAS, DEFAULT_JOIN, DEFAULT_RESULT_SIZE, DRAWING_DEPENDENTS_AS_OTHER_DEPENDENTS, DRAWING_REQUIRED_DEPENDENTS, DRAWINGS_OF_SEEDS, FORWARD_ORDER, FT_MEMBERS_OF_SEEDS, LEFT_JOIN, NO_ASSOCIATED, NO_DEPENDENTS, NO_DRAWING_DEPENDENTS, NO_DRAWINGS, NO_FT_MEMBERS, NO_REPEAT_LIMIT, NO_SAVE_LINKS, NO_SCOPE, REQUIRED_DEPENDENTS, RIGHT_JOIN, SAVE_LIGHT_LINKS, SAVE_LINKS, SEED_SCOPE, STANDARD_SCOPE

Constructor Summary

FamilyTableHelper()

FamilyTableHelper(WTCollection input)

Method Summary

private void	addCompatibleVersion(BigDecimal versionMasterId, BigDecimal versionId, Set members, WTSet compatibleSet)
private void	debugPrint(String msg, Collection c)
FamilyTableResult	getFamilyInfo() Returns FamilyTableResult which present information about found FT versions.
private FamilyTableResult	getFamilyInfo(boolean autoResolveIncompatibility)
FamilyTableResult	getFamilyInfoWithAutoResolvingIncompatibility() Returns FamilyTableResult which present information about found FT versions.
void	setContainer(WTContainer container) Set container
void	setFilterInstancesByInput(boolean filterInstancesByInput) Consider only the instances from input if true else all existing instances of the generics.
void	setFolder(Folder folder) Set folder where objects from input are located.
void	setInput(WTCollection input)
void	setIsInputFromWorkspace(boolean isInputFromWorkspace) Set flag that input collection from the given workspace.
void	setWorkspace(EPMWorkspace ws) Set workspace where objects from input are located.

Methods inherited from class java.lang.Object

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

Field Detail

input

WTCollection input

filterInstancesByInput

boolean filterInstancesByInput

isInputFromWorkspace

boolean isInputFromWorkspace

ws

EPMWorkspace ws

container

WTContainer container

folder

Folder folder

MASTER_ID

private static final String MASTER_ID

See Also:

Constant Field Values

FAMILIES

private static final String FAMILIES

See Also:

Constant Field Values

MEMBERS

private static final String MEMBERS

See Also:

Constant Field Values

GENERICS

private static final String GENERICS

See Also:

Constant Field Values

VARIANT_LINKS

private static final String VARIANT_LINKS

See Also:

Constant Field Values

CONTAINEDIN_LINKS

private static final String CONTAINEDIN_LINKS

See Also:

Constant Field Values

CHECKPOINT_ALIAS

private static final String CHECKPOINT_ALIAS

See Also:

Constant Field Values

iterCl

final Class iterCl

masterCl

final Class masterCl

memberCl

final Class memberCl

linkCl

final Class linkCl

wsCl

final Class wsCl

log

private static Log log

logging

Constructor Detail

FamilyTableHelper

public FamilyTableHelper()

FamilyTableHelper

public FamilyTableHelper(WTCollection input)

Method Detail

setInput

public void setInput(WTCollection input)

setWorkspace

public void setWorkspace(EPMWorkspace ws)

Set workspace where objects from input are located.

setContainer

public void setContainer(WTContainer container)

Set container

setFolder

public void setFolder(Folder folder)

Set folder where objects from input are located.

setIsInputFromWorkspace

public void setIsInputFromWorkspace(boolean isInputFromWorkspace)

Set flag that input collection from the given workspace.

setFilterInstancesByInput

public void setFilterInstancesByInput(boolean filterInstancesByInput)

Consider only the instances from input if true else all existing instances of the generics.

getFamilyInfo

public FamilyTableResult getFamilyInfo()
                                throws WTException,
                                       WTPropertyVetoException

Returns FamilyTableResult which present information about found FT versions. This result can hold the information about incompatible members from input if they found. throws WTException, WTPropertyVetoException

Throws:

WTException

WTPropertyVetoException

getFamilyInfoWithAutoResolvingIncompatibility

public FamilyTableResult getFamilyInfoWithAutoResolvingIncompatibility()
                                                                throws WTException,
                                                                       WTPropertyVetoException

Returns FamilyTableResult which present information about found FT versions. This result always return the latest FT version if can not find a version compatible for members from input. throws WTException, WTPropertyVetoException

Throws:

WTException

WTPropertyVetoException

getFamilyInfo

private FamilyTableResult getFamilyInfo(boolean autoResolveIncompatibility)
                                 throws WTException,
                                        WTPropertyVetoException

Throws:

WTException

WTPropertyVetoException

addCompatibleVersion

private void addCompatibleVersion(BigDecimal versionMasterId,
                                  BigDecimal versionId,
                                  Set members,
                                  WTSet compatibleSet)
                           throws WTException

Throws:

WTException

debugPrint

private void debugPrint(String msg,
                        Collection c)
                 throws WTException

Throws:

WTException