com.technia.tvc.structurebrowser.buildstructure

Class BuildStructureConfiguration

java.lang.Object

com.technia.tvc.core.db.aef.env.BasicEnvironmentSupport

com.technia.tvc.structurebrowser.buildstructure.BuildStructureConfiguration

All Implemented Interfaces:

EnvironmentSupport

public class BuildStructureConfiguration
extends BasicEnvironmentSupport

This class holds configuration information regarding the BuildStructure function.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UNDEFINED_REL

Fields inherited from class com.technia.tvc.core.db.aef.env.BasicEnvironmentSupport

env

Constructor Summary

Constructors

Constructor and Description
BuildStructureConfiguration() Constructs a new instance

Method Summary

Modifier and Type	Method and Description
protected com.technia.tvc.structurebrowser.buildstructure.ConnectionGroup	createConnectionGroup() Creates the ConnectionGroup instance to be used.
protected com.technia.tvc.structurebrowser.buildstructure.ConnectionInfo	createConnectionInfo() Creates the ConnectionInfo instance to be used.
com.technia.tvc.structurebrowser.buildstructure.ConnectionInfo[]	createConnectionInfos() Creates new ConnectionInfo and adds it to this configuration.
FlatTableBean	createTableBeanForEdit()
java.lang.String[]	getAllowedRelations() Returns the limited relationship list (if any).
boolean	getCanEditRelationshipAttributes() Returns true if user is allowed to edit the relationship attributes
boolean	getCanSelectRelationships() Returns true if user is allowed to select relatioinships
java.util.Collection<java.lang.String>	getChoosableRelationships() Returns a list of relationships, that may be used to connect the specified objects based upon this configuration.
com.technia.tvc.structurebrowser.buildstructure.ConnectionGroup	getConnectionGroup(java.lang.String relType) Returns a specific ConnectionGroup instance matching the given relationship type, or null if none exists for this configuration.
com.technia.tvc.structurebrowser.buildstructure.ConnectionGroup[]	getConnectionGroups() Returns all ConnectionGroup instances held by this configuration.
com.technia.tvc.structurebrowser.buildstructure.ConnectionInfo	getConnectionInfoById(java.lang.String id) Returns a connection id based upon the id or null if none exists.
com.technia.tvc.structurebrowser.buildstructure.ConnectionInfo[]	getConnectionInfos() Returns all ConnectionInfo instances created.
boolean	getCopyRelationshipAttributes()
com.technia.tvc.structurebrowser.buildstructure.Direction	getDefaultDirection() Returns the default direction
java.lang.String	getDefaultRelationship() Returns the name of the default relationship.
com.technia.tvc.structurebrowser.buildstructure.Layout	getLayout()
StructureBean	getOriginStructure()
TableBean<?>	getOriginTable()
TableRenderer	getRendererForAttributesEdit()
java.util.List<java.lang.String>	getSourceOids() Returns the object id of the source object
java.util.List<java.lang.String>	getSourceRids()
java.util.List<java.lang.String>	getTargetOids() Returns the object id(s) of the target object(s)
boolean	hasUndefinedConnection() Returns true if this configuration contains at least one ConnectionInfo instance with an undefined relationship.
protected void	init() initializes the instance variables
boolean	isAutoLoad()
boolean	isMoveAllowed()
boolean	isRelationshipAllowed(java.lang.String relationship) Check if the given relationship is allowed to use within this configuration
boolean	isReplaceAllowed()
protected java.lang.String	paramString()
void	recycle() Recycles this instance, e.g.
void	remove(com.technia.tvc.structurebrowser.buildstructure.ConnectionInfo cInfo) Removes a ConnectionInfo instance from this configuration
StructureModifiableTableBean.ReplaceResult	replaceObject(StructureModifiableTableBean<?> target, java.lang.String relationshipId, java.lang.String objectId, java.lang.String newObjectId) Performs a replace of the source object with the target object, on the specified relationship.
void	setAllowedRelations(java.lang.String[] allowedRelations) Limits the relationship types used for this configuration
void	setAutoLoad(boolean autoLoad)
void	setCanEditRelationshipAttributes(boolean canEditRelationshipAttributes) Specify if the user may/may not edit the relationship attributes after the connection(s) has been made.
void	setCanSelectRelationships(boolean canSelectRelationships) Specify if the user may/may not manually specify the relationship to use for each connection made.
void	setCopyRelationshipAttributes(boolean copyRelationshipAttributes)
void	setDefaultDirection(boolean isFrom)
void	setDefaultDirection(com.technia.tvc.structurebrowser.buildstructure.Direction defaultDir) Set the default direction to use when building structures Default is FROM.
void	setDefaultRelationship(java.lang.String defaultRelationship) Sets the default relationship to use.
void	setLayout(com.technia.tvc.structurebrowser.buildstructure.Layout layout)
void	setMoveAllowed(boolean enabled)
void	setOriginTable(TableBean<?> table)
void	setReplaceAllowed(boolean enabled)
void	setSource(java.lang.String[] sourceRids, java.lang.String[] sourceOids)
void	setTarget(java.lang.String[] targetRids, java.lang.String[] targetOids)
java.lang.String	toString() Returns a string representation of the component.

Methods inherited from class com.technia.tvc.core.db.aef.env.BasicEnvironmentSupport

getEnv, getEnv, setEnv

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED_REL

public static final java.lang.String UNDEFINED_REL

See Also:

Constant Field Values

Constructor Detail

BuildStructureConfiguration

public BuildStructureConfiguration()

Constructs a new instance

Method Detail

createConnectionGroup

protected com.technia.tvc.structurebrowser.buildstructure.ConnectionGroup createConnectionGroup()

Creates the ConnectionGroup instance to be used.

Since:

4.1.0

createConnectionInfo

protected com.technia.tvc.structurebrowser.buildstructure.ConnectionInfo createConnectionInfo()

Creates the ConnectionInfo instance to be used.

Since:

4.1.0

createConnectionInfos

public com.technia.tvc.structurebrowser.buildstructure.ConnectionInfo[] createConnectionInfos()
                                                                                       throws java.lang.IllegalArgumentException

Creates new ConnectionInfo and adds it to this configuration.

Throws:

java.lang.IllegalArgumentException - Upon argument error

createTableBeanForEdit

public FlatTableBean createTableBeanForEdit()

getAllowedRelations

public java.lang.String[] getAllowedRelations()

Returns the limited relationship list (if any).

getCanEditRelationshipAttributes

public boolean getCanEditRelationshipAttributes()

Returns true if user is allowed to edit the relationship attributes

getCanSelectRelationships

public boolean getCanSelectRelationships()

Returns true if user is allowed to select relatioinships

getChoosableRelationships

public java.util.Collection<java.lang.String> getChoosableRelationships()
                                                                 throws TVCException

Returns a list of relationships, that may be used to connect the specified objects based upon this configuration.

Throws:

TVCException - If unable to retreive data from the database

getConnectionGroup

public com.technia.tvc.structurebrowser.buildstructure.ConnectionGroup getConnectionGroup(java.lang.String relType)

Returns a specific ConnectionGroup instance matching the given relationship type, or null if none exists for this configuration.

Returns:

A ConnectionGroup or null

getConnectionGroups

public com.technia.tvc.structurebrowser.buildstructure.ConnectionGroup[] getConnectionGroups()

Returns all ConnectionGroup instances held by this configuration.

Returns:

An array of ConnectionGroup instances.

getConnectionInfoById

public com.technia.tvc.structurebrowser.buildstructure.ConnectionInfo getConnectionInfoById(java.lang.String id)

Returns a connection id based upon the id or null if none exists.

getConnectionInfos

public com.technia.tvc.structurebrowser.buildstructure.ConnectionInfo[] getConnectionInfos()

Returns all ConnectionInfo instances created.

getCopyRelationshipAttributes

public boolean getCopyRelationshipAttributes()

getDefaultDirection

public com.technia.tvc.structurebrowser.buildstructure.Direction getDefaultDirection()

Returns the default direction

getDefaultRelationship

public java.lang.String getDefaultRelationship()

Returns the name of the default relationship.

getLayout

public com.technia.tvc.structurebrowser.buildstructure.Layout getLayout()

getOriginStructure

public StructureBean getOriginStructure()

getOriginTable

public TableBean<?> getOriginTable()

getRendererForAttributesEdit

public TableRenderer getRendererForAttributesEdit()

getSourceOids

public java.util.List<java.lang.String> getSourceOids()

Returns the object id of the source object

getSourceRids

public java.util.List<java.lang.String> getSourceRids()

getTargetOids

public java.util.List<java.lang.String> getTargetOids()

Returns the object id(s) of the target object(s)

hasUndefinedConnection

public boolean hasUndefinedConnection()

Returns true if this configuration contains at least one ConnectionInfo instance with an undefined relationship.

init

protected void init()

initializes the instance variables

isAutoLoad

public boolean isAutoLoad()

Returns:

Returns whether the source table will be loaded automatically, i.e., no search.

Since:

5.1

isMoveAllowed

public boolean isMoveAllowed()

isRelationshipAllowed

public boolean isRelationshipAllowed(java.lang.String relationship)

Check if the given relationship is allowed to use within this configuration

isReplaceAllowed

public boolean isReplaceAllowed()

paramString

protected java.lang.String paramString()

recycle

public void recycle()

Recycles this instance, e.g. setting all internal variables to their default values.

remove

public void remove(com.technia.tvc.structurebrowser.buildstructure.ConnectionInfo cInfo)

Removes a ConnectionInfo instance from this configuration

replaceObject

public StructureModifiableTableBean.ReplaceResult replaceObject(StructureModifiableTableBean<?> target,
                                                                java.lang.String relationshipId,
                                                                java.lang.String objectId,
                                                                java.lang.String newObjectId)
                                                         throws TVCException

Performs a replace of the source object with the target object, on the specified relationship.

Parameters:

target -

relationshipId -

objectId -

newObjectId -

Returns:

The StructureModifiableTableBean.ReplaceResult

Throws:

TVCException

setAllowedRelations

public void setAllowedRelations(java.lang.String[] allowedRelations)

Limits the relationship types used for this configuration

setAutoLoad

public void setAutoLoad(boolean autoLoad)

Parameters:

autoLoad - Whether the source table will be loaded automatically, i.e., no search.

Since:

5.1

setCanEditRelationshipAttributes

public void setCanEditRelationshipAttributes(boolean canEditRelationshipAttributes)

Specify if the user may/may not edit the relationship attributes after the connection(s) has been made.

setCanSelectRelationships

public void setCanSelectRelationships(boolean canSelectRelationships)

Specify if the user may/may not manually specify the relationship to use for each connection made.

setCopyRelationshipAttributes

public void setCopyRelationshipAttributes(boolean copyRelationshipAttributes)

setDefaultDirection

public void setDefaultDirection(boolean isFrom)

setDefaultDirection

public void setDefaultDirection(com.technia.tvc.structurebrowser.buildstructure.Direction defaultDir)

Set the default direction to use when building structures Default is FROM.

setDefaultRelationship

public void setDefaultRelationship(java.lang.String defaultRelationship)

Sets the default relationship to use.

setLayout

public void setLayout(com.technia.tvc.structurebrowser.buildstructure.Layout layout)

setMoveAllowed

public void setMoveAllowed(boolean enabled)

setOriginTable

public void setOriginTable(TableBean<?> table)

setReplaceAllowed

public void setReplaceAllowed(boolean enabled)

setSource

public void setSource(java.lang.String[] sourceRids,
                      java.lang.String[] sourceOids)

setTarget

public void setTarget(java.lang.String[] targetRids,
                      java.lang.String[] targetOids)

toString

public java.lang.String toString()

Returns a string representation of the component.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the component.