org.mmbase.module.corebuilders
Class TypeRel

java.lang.Object
  org.mmbase.module.core.MMTable
      org.mmbase.module.core.MMObjectBuilder
          org.mmbase.module.corebuilders.TypeRel

All Implemented Interfaces:

MMBaseObserver

public class TypeRel

extends MMObjectBuilder

implements MMBaseObserver

TypeRel defines the allowed relations between two object types. Every relations also specifies a 'role', which is a reference to the RelDef table. Relations do principally have a 'source' and a 'destination' object type, but most functions of this class do ignore this distinction. TypeRel is a 'core' MMBase builder. You can get a reference to it via the MMBase instance.

Version:

$Id: TypeRel.java,v 1.47.2.2 2005/07/07 11:48:57 michiel Exp $

Author:

Daniel Ockeloen, Pierre van Rooden, Michiel Meeuwissen

See Also:

RelDef, InsRel, MMBase

Nested Class Summary

protected class	TypeRel.InverseTypeRelSet An InverseTypeRelSet is a Set of typerel nodes.
protected class	TypeRel.TypeRelSet A TypeRelSet is a Set of typerel nodes.
protected class	TypeRel.VirtualTypeRelNode A VirtualTypeRelNode is a MMObjectNode which is added to the typerelset with extensions of the actual builders specified.

Field Summary

static int	INCLUDE_DESCENDANTS Constant for contains(int, int, int): return typerels where source/destination match with a builder or its descendants
static int	INCLUDE_PARENTS Constant for contains(int, int, int): return typerels where source/destination match with a builder or its parents
static int	INCLUDE_PARENTS_AND_DESCENDANTS Constant for contains(int, int, int): return typerels where source/destination match with a builder, its descendants, or its parents
static int	STRICT Constant for contains(int, int, int): return only typerels that exactly match.

Fields inherited from class org.mmbase.module.core.MMObjectBuilder

AGE_PARAMETERS, broadcastChanges, database, DEFAULT_ALINEA, DEFAULT_EOL, description, descriptions, fields, GUI_PARAMETERS, listCache, nodeCache, OBJ2TYPE_MAX_SIZE, oType, REPLACE_CACHE, searchAge, sortedDBLayout, TEMPNODE_DEFAULT_SIZE, TemporaryNodes, virtual

Fields inherited from class org.mmbase.module.core.MMTable

mmb, tableName

Constructor Summary

TypeRel()

Method Summary

protected TypeRel.TypeRelSet	addCacheEntry(MMObjectNode typerel, boolean buildersInitialized) Addes one typerel cache entries, plus inherited relations (if builder are initialized)
boolean	contains(int n1, int n2, int r) Tests if a specific relation type is defined.
boolean	contains(int n1, int n2, int r, int restriction) Tests if a specific relation type is defined.
boolean	equals(MMObjectNode o1, MMObjectNode o2) Implements equals for a typerel node.
java.util.Enumeration	getAllowedRelations(int otype)
java.util.Enumeration	getAllowedRelations(int builder1, int builder2) An enumeration of all allowed relations between two builders.
java.util.Set	getAllowedRelations(int builder1, int builder2, int role) A Set of all allowed relations of a certain role between two builders.
java.util.Enumeration	getAllowedRelations(MMObjectNode mmnode) Retrieves all relations which are 'allowed' for a specified node, that is, where the node is either allowed to be the source, or to be the destination (but where the corresponing relation definition is bidirectional).
java.util.Enumeration	getAllowedRelations(MMObjectNode n1, MMObjectNode n2) Retrieves all relations which are 'allowed' between two specified nodes.
protected java.util.Vector	getAllowedRelationsNames(int number1, int number2) Retrieves all relations which are 'allowed' between two specified nodes.
int	getAllowedRelationType(int snum, int dnum) Retrieves the identifying number of the relation definition that is 'allowed' between two specified node types.
java.lang.String	getGUIIndicator(MMObjectNode node) Returns the display string for this node It returns a commbination of objecttypes and rolename : "source->destination (role)".
java.lang.String	getGUIIndicator(java.lang.String field, MMObjectNode node) Returns the display string for a specified field.
java.util.Vector	getList(scanpage sp, StringTagger tagger, java.util.StringTokenizer tok) Processes the BUILDER-typerel-ALLOWEDRELATIONSNAMES in the LIST command, and (possibly) returns a Vector containing requested data (based on the content of TYPE and NODE, which can be retrieved through tagger).
int	hashCode(MMObjectNode o) Implements for MMObjectNode
boolean	init() Initializes this builder The property 'mmb' needs to be set for the builder before this method can be called.
int	insert(java.lang.String owner, MMObjectNode node) Insert a new object (content provided) in the cloud, including an entry for the object alias (if provided).
boolean	nodeChanged(java.lang.String machine, java.lang.String number, java.lang.String builder, java.lang.String ctype) Watch for changes on relation types and adjust our memory table accordingly
boolean	nodeLocalChanged(java.lang.String machine, java.lang.String number, java.lang.String builder, java.lang.String ctype) Called when a local node is changed.
boolean	nodeRemoteChanged(java.lang.String machine, java.lang.String number, java.lang.String builder, java.lang.String ctype) Called when a remote node is changed.
boolean	optimizeRelationStep(BasicRelationStep relationStep, int sourceType, int destinationType, int roleInt, int searchDir) Optimize as relation step by considering restrictions of TypeRel.
void	readCache() The TypeRel cache contains all TypeRels MMObjectNodes.
boolean	reldefCorrect(int n1, int n2, int r) Deprecated. use contains(int, int, int) instead
void	removeNode(MMObjectNode node) Remove a node from the cloud.
java.lang.String	toString(MMObjectNode n) Implements for MMObjectNode

Methods inherited from class org.mmbase.module.core.MMObjectBuilder

addField, addLocalObserver, addRemoteObserver, buildSet, checkAddTmpField, commit, convertMMNode2SQL, count, count, create, createAlias, delete, deleteNodeCache, drop, equals, executeFunction, executeFunction, fieldLocalChanged, getAge, getAliasedNode, getAncestors, getCacheNumbers, getCacheSize, getCacheSize, getClassName, getConfigFile, getDBByte, getDBKey, getDBState, getDBText, getDBType, getDefaultTeaser, getDefaultUrl, getDescendants, getDescription, getDescription, getDescriptions, getEditFields, getField, getFieldNames, getFields, getFields, getFunctionParameters, getHardNode, getHardNode, getHTML, getInitParameter, getInitParameters, getLocaleGUIIndicator, getLocaleGUIIndicator, getMachineName, getMaintainer, getMMBase, getNewNode, getNewTmpNode, getNextField, getNextField, getNode, getNode, getNode, getNode, getNodes, getNodes, getNodeType, getNumberFromName, getObjectType, getObjectValue, getParameterDefinition, getParentBuilder, getPluralName, getPluralName, getPluralNames, getQuery, getQuery, getQuery, getRawNodes, getRelations_main, getSearchAge, getShort, getShortedByte, getShortedText, getSingularName, getSingularName, getSingularNames, getSmartPath, getSortedFields, getSortedListFields, getTmpNode, getURLEncode, getValue, getVersion, getWAP, getXMLPath, hostname_function, insert, insertDone, isExtensionOf, isNodeCached, isVirtual, preCommit, preEdit, process, processSearchResults, putTmpNode, readSearchResults, removeField, removeRelations, removeSyncNodes, removeTmpNode, replace, safeCache, safeCommit, safeInsert, search, search, search, searchIn, searchIn, searchIn, searchList, searchList, searchNumbers, searchVector, searchVector, searchVector, searchVector, searchVectorIn, searchVectorIn, searchVectorIn, searchVectorIn, searchWithWhere, sendFieldChangeSignal, setDBLayout_xml, setDefaults, setDescription, setDescriptions, setInitParameter, setMaintainer, setMMBase, setParentBuilder, setPluralNames, setSearchAge, setSingularNames, setTableName, setUniqueValue, setUniqueValue, setValue, setValue, setVersion, setXMLPath, setXMLValues, signalNewObject, testValidData, toString, toXML, updateFields, waitUntilNodeChanged, wrap

Methods inherited from class org.mmbase.module.core.MMTable

created, getFullTableName, getTableName, size

Methods inherited from class java.lang.Object

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

Field Detail

STRICT

public static final int STRICT

Constant for contains(int, int, int): return only typerels that exactly match.

See Also:

Constant Field Values

INCLUDE_DESCENDANTS

public static final int INCLUDE_DESCENDANTS

Constant for contains(int, int, int): return typerels where source/destination match with a builder or its descendants

See Also:

Constant Field Values

INCLUDE_PARENTS

public static final int INCLUDE_PARENTS

Constant for contains(int, int, int): return typerels where source/destination match with a builder or its parents

See Also:

Constant Field Values

INCLUDE_PARENTS_AND_DESCENDANTS

public static final int INCLUDE_PARENTS_AND_DESCENDANTS

Constant for contains(int, int, int): return typerels where source/destination match with a builder, its descendants, or its parents

See Also:

Constant Field Values

Constructor Detail

TypeRel

public TypeRel()

Method Detail

init

public boolean init()

Description copied from class: MMObjectBuilder

Initializes this builder The property 'mmb' needs to be set for the builder before this method can be called. The method retrieves data from the TypeDef builder, or adds data to that builder if the current builder is not yet registered.

Overrides:

init in class MMObjectBuilder

Returns:

true if init was completed, false if uncompleted.

See Also:

MMObjectBuilder.create()

readCache

public void readCache()

The TypeRel cache contains all TypeRels MMObjectNodes. Called after init by MMBase, and when something changes.

Since:

MMBase-1.6.2

addCacheEntry

protected TypeRel.TypeRelSet addCacheEntry(MMObjectNode typerel,
                                           boolean buildersInitialized)

Addes one typerel cache entries, plus inherited relations (if builder are initialized)

Returns:

A Set with the added entries, which can be used for logging or so, or can be disregarded

Since:

MMBase-1.6.2

insert

public int insert(java.lang.String owner,
                  MMObjectNode node)

Insert a new object (content provided) in the cloud, including an entry for the object alias (if provided). This method indirectly calls MMObjectBuilder.preCommit(org.mmbase.module.core.MMObjectNode). If the typerel node specified already exists (i.e. same snumber, dnumber,a nd rnumber fielfds), the typerel creation fails and returns -1.

Overrides:

insert in class MMObjectBuilder

Parameters:

owner - The administrator creating the node

node - The object to insert. The object need be of the same type as the current builder.

Returns:

An int value which is the new object's unique number, -1 if the insert failed.

removeNode

public void removeNode(MMObjectNode node)

Remove a node from the cloud.

Overrides:

removeNode in class MMObjectBuilder

Parameters:

node - The node to remove.

getAllowedRelations

public java.util.Enumeration getAllowedRelations(MMObjectNode mmnode)

Retrieves all relations which are 'allowed' for a specified node, that is, where the node is either allowed to be the source, or to be the destination (but where the corresponing relation definition is bidirectional). The allowed relations are determined by the type of the node

Parameters:

mmnode - The node to retrieve the allowed relations of.

Returns:

An Enumeration of nodes containing the typerel relation data

getAllowedRelations

public java.util.Enumeration getAllowedRelations(int otype)

getAllowedRelations

public java.util.Enumeration getAllowedRelations(MMObjectNode n1,
                                                 MMObjectNode n2)

Retrieves all relations which are 'allowed' between two specified nodes. No distinction between source / destination.

Parameters:

n1 - The first objectnode

n2 - The second objectnode

Returns:

An Enumeration of nodes containing the typerel relation data

getAllowedRelations

public java.util.Enumeration getAllowedRelations(int builder1,
                                                 int builder2)

An enumeration of all allowed relations between two builders. No distinction is made between source and destination.

getAllowedRelations

public java.util.Set getAllowedRelations(int builder1,
                                         int builder2,
                                         int role)

A Set of all allowed relations of a certain role between two builders. No distinction between source and destination.

Since:

MMBase-1.6.2

getAllowedRelationsNames

protected java.util.Vector getAllowedRelationsNames(int number1,
                                                    int number2)

Retrieves all relations which are 'allowed' between two specified nodes.

Returns:

An Enumeration of nodes containing the reldef (not typerel!) sname field

getAllowedRelationType

public int getAllowedRelationType(int snum,
                                  int dnum)

Retrieves the identifying number of the relation definition that is 'allowed' between two specified node types. The results are dependent on there being only one type of relation between two node types (not enforced, thus unpredictable). Makes use of a typeRelNodes.

Parameters:

snum - The first objectnode type (the source)

dnum - The second objectnode type (the destination)

Returns:

the number of the found relation, or -1 if either no relation was found, or more than one was found.

getGUIIndicator

public java.lang.String getGUIIndicator(MMObjectNode node)

Returns the display string for this node It returns a commbination of objecttypes and rolename : "source->destination (role)".

Overrides:

getGUIIndicator in class MMObjectBuilder

Parameters:

node - Node from which to retrieve the data

Returns:

A String describing the content of the node

getGUIIndicator

public java.lang.String getGUIIndicator(java.lang.String field,
                                        MMObjectNode node)

Returns the display string for a specified field. Returns, for snumber and dnumber, the name of the objecttype they represent, and for rnumber the display (GUI) string for the indicated relation definition.

Overrides:

getGUIIndicator in class MMObjectBuilder

Parameters:

field - The name of the field to retrieve

node - Node from which to retrieve the data

Returns:

A String describing the content of the field

getList

public java.util.Vector getList(scanpage sp,
                                StringTagger tagger,
                                java.util.StringTokenizer tok)

Processes the BUILDER-typerel-ALLOWEDRELATIONSNAMES in the LIST command, and (possibly) returns a Vector containing requested data (based on the content of TYPE and NODE, which can be retrieved through tagger).

Overrides:

getList in class MMObjectBuilder

Parameters:

sp - The scanpage (containing http and user info) that calls the function

tagger - a Hashtable of parameters (name-value pairs) for the command

tok - a list of strings that describe the (sub)command to execute

Returns:

a Vector containing the result values as a String

Warning: No Java Documentation Available.

parameters

reldefCorrect

public boolean reldefCorrect(int n1,
                             int n2,
                             int r)

Deprecated. use contains(int, int, int) instead

Tests if a specific relation type is defined.

Note that this routine returns false both when a snumber/dnumber are swapped, and when a typecombo does not exist - it is not possible to derive whether one or the other has occurred.

Parameters:

n1 - The source type number.

n2 - The destination type number.

r - The relation definition (role) number, or -1 if the role does not matter

Returns:

true when the relation exists, false otherwise.

contains

public boolean contains(int n1,
                        int n2,
                        int r)

Tests if a specific relation type is defined. The method also returns true if the typerel occurs as a virtual (derived) node.

Note that this routine returns false both when a snumber/dnumber are swapped, and when a typecombo does not exist - it is not possible to derive whether one or the other has occurred.

Parameters:

n1 - The source type number.

n2 - The destination type number.

r - The relation definition (role) number, or -1 if the role does not matter

Returns:

true when the relation exists, false otherwise.

Since:

MMBase-1.6.2

contains

public boolean contains(int n1,
                        int n2,
                        int r,
                        int restriction)

Tests if a specific relation type is defined.

Note that this routine returns false both when a snumber/dnumber are swapped, and when a typecombo does not exist - it is not possible to derive whether one or the other has occurred.

Parameters:

n1 - The source type number.

n2 - The destination type number.

r - The relation definition (role) number, or -1 if the role does not matter r can only be -1 if virtual is true

restriction - if STRICT, contains only returns true if the typerel occurs as-is in the database. if INCLUDE_DESCENDANTS, contains returns true if the typerel occurs as a virtual (derived) node, where source or destination may also be descendants of the specified type. if INCLUDE_PARENTS, contains returns true if the typerel occurs as a virtual (derived) node, where source or destination may also be parents of the specified type. if INCLUDE_PARENTS_AND_DESCENDANTS, contains returns true if the typerel occurs as a virtual (derived) node, where source or destination may also be descendants or parents of the specified type.

Returns:

true when the relation exists, false otherwise.

Since:

MMBase-1.6.2

nodeRemoteChanged

public boolean nodeRemoteChanged(java.lang.String machine,
                                 java.lang.String number,
                                 java.lang.String builder,
                                 java.lang.String ctype)

Description copied from interface: MMBaseObserver

Called when a remote node is changed.

Specified by:

nodeRemoteChanged in interface MMBaseObserver

Overrides:

nodeRemoteChanged in class MMObjectBuilder

Parameters:

machine - Name of the machine that changed the node.

number - Number of the changed node as a String

builder - type of the changed node

ctype - command type, 'c'=changed, 'd'=deleted', 'r'=relations changed, 'n'=new

Returns:

always true

nodeLocalChanged

public boolean nodeLocalChanged(java.lang.String machine,
                                java.lang.String number,
                                java.lang.String builder,
                                java.lang.String ctype)

Description copied from interface: MMBaseObserver

Called when a local node is changed.

Specified by:

nodeLocalChanged in interface MMBaseObserver

Overrides:

nodeLocalChanged in class MMObjectBuilder

Parameters:

machine - Name of the machine that changed the node.

number - Number of the changed node as a String

builder - type of the changed node

ctype - command type, 'c'=changed, 'd'=deleted', 'r'=relations changed, 'n'=new

Returns:

always true

nodeChanged

public boolean nodeChanged(java.lang.String machine,
                           java.lang.String number,
                           java.lang.String builder,
                           java.lang.String ctype)

Watch for changes on relation types and adjust our memory table accordingly

To Do:

Should update artCache en relDefCorrectCache as wel

optimizeRelationStep

public boolean optimizeRelationStep(BasicRelationStep relationStep,
                                    int sourceType,
                                    int destinationType,
                                    int roleInt,
                                    int searchDir)

Optimize as relation step by considering restrictions of TypeRel. TypeRel defines which type of relations may be created, ergo can exist.

Since:

MMBase-1.7

equals

public boolean equals(MMObjectNode o1,
                      MMObjectNode o2)

Implements equals for a typerel node. Two nodes are equal if the snumber and dnumber fields are the same, and the rnumber fields are the same, or one of these is '-1' (don't care).

Overrides:

equals in class MMObjectBuilder

Since:

MMBase-1.6.2

hashCode

public int hashCode(MMObjectNode o)

Implements for MMObjectNode

Overrides:

hashCode in class MMObjectBuilder

Since:

MMBase-1.6.2

toString

public java.lang.String toString(MMObjectNode n)

Description copied from class: MMObjectBuilder

Implements for MMObjectNode

Overrides:

toString in class MMObjectBuilder