Class RelationTypeSupport
- All Implemented Interfaces:
Serializable, RelationType
It represents a relation type, providing role information for each role expected to be supported in every relation of that type.
A relation type includes a relation type name and a list of role infos (represented by RoleInfo objects).
A relation type has to be declared in the Relation Service:
- either using the createRelationType() method, where a RelationTypeSupport object will be created and kept in the Relation Service
- either using the addRelationType() method where the user has to create an object implementing the RelationType interface, and this object will be used as representing a relation type in the Relation Service.
The serialVersionUID of this class is 4611072955724144607L.
- Since:
- 1.5
- See Also:
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedRelationTypeSupport(String relationTypeName) Constructor to be used for subclasses.RelationTypeSupport(String relationTypeName, RoleInfo[] roleInfoArray) Constructor where all role definitions are dynamically created and passed as parameter. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddRoleInfo(RoleInfo roleInfo) Add a role info.Returns the relation type name.getRoleInfo(String roleInfoName) Returns the role info (RoleInfo object) for the given role info name (null if not found).Returns the list of role definitions (ArrayList of RoleInfo objects).Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitModifier and TypeMethodDescriptionprotected Objectclone()Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.booleanCompares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.protected voidfinalize()Deprecated, for removal: This API element is subject to removal in a future version.May cause performance issues, deadlocks and hangs.getClass()Answers the unique instance of java.lang.Class which represents the class of the receiver.inthashCode()Answers an integer hash code for the receiver.final voidnotify()Causes one thread which iswaiting on the receiver to be made ready to run.final voidCauses all threads which arewaiting on the receiver to be made ready to run.toString()Answers a string containing a concise, human-readable description of the receiver.final voidwait()Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated bynotifyornotifyAll).final voidwait(long time) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated bynotifyornotifyAll) or the expiration of the timeout.final voidwait(long time, int frac) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated bynotifyornotifyAll) or the expiration of the timeout.
-
Constructor Details
-
RelationTypeSupport
public RelationTypeSupport(String relationTypeName, RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException Constructor where all role definitions are dynamically created and passed as parameter.- Parameters:
relationTypeName- Name of relation typeroleInfoArray- List of role definitions (RoleInfo objects)- Throws:
IllegalArgumentException- if null parameterInvalidRelationTypeException- if:- the same name has been used for two different roles
- no role info provided
- one null role info provided
-
RelationTypeSupport
Constructor to be used for subclasses.- Parameters:
relationTypeName- Name of relation type.- Throws:
IllegalArgumentException- if null parameter.
-
-
Method Details
-
getRelationTypeName
Returns the relation type name.- Specified by:
getRelationTypeNamein interfaceRelationType- Returns:
- the relation type name.
-
getRoleInfos
Returns the list of role definitions (ArrayList of RoleInfo objects).- Specified by:
getRoleInfosin interfaceRelationType- Returns:
- an
ArrayListofRoleInfo.
-
getRoleInfo
public RoleInfo getRoleInfo(String roleInfoName) throws IllegalArgumentException, RoleInfoNotFoundException Returns the role info (RoleInfo object) for the given role info name (null if not found).- Specified by:
getRoleInfoin interfaceRelationType- Parameters:
roleInfoName- role info name- Returns:
- RoleInfo object providing role definition does not exist
- Throws:
IllegalArgumentException- if null parameterRoleInfoNotFoundException- if no role info with that name in relation type.
-
addRoleInfo
protected void addRoleInfo(RoleInfo roleInfo) throws IllegalArgumentException, InvalidRelationTypeException Add a role info. This method of course should not be used after the creation of the relation type, because updating it would invalidate that the relations created associated to that type still conform to it. Can throw a RuntimeException if trying to update a relation type declared in the Relation Service.- Parameters:
roleInfo- role info to be added.- Throws:
IllegalArgumentException- if null parameter.InvalidRelationTypeException- if there is already a role info in current relation type with the same name.
-