org.yawlfoundation.yawl.resourcing.datastore.orgdata
Class ResourceDataSet

java.lang.Object
  org.yawlfoundation.yawl.resourcing.datastore.orgdata.ResourceDataSet

public class ResourceDataSet
extends Object

Handles the loading, mapping and runtime management of resources from data source.

Author:

Michael Adams

Created/Last Date:

4/11/2009 (orginally extracted from ResourceManager class)

Nested Class Summary

static class	ResourceDataSet.Identifier
static class	ResourceDataSet.ResUnit

Constructor Summary

ResourceDataSet(DataSource source)

Method Summary

String	addCapability(Capability c)
String	addNonHumanCategory(NonHumanCategory c)
String	addNonHumanResource(NonHumanResource r)
String	addOrgGroup(OrgGroup o)
String	addParticipant(Participant p)
String	addPosition(Position p)
String	addRole(Role r)
void	augmentDataSourceAsRequired()
Set<Participant>	castToParticipantSet(Set<AbstractResource> resources)
String	checkCyclicAttributeReference(AbstractResourceAttribute resource, String parentID)
String	checkCyclicOrgGroupReference(OrgGroup orgGroup, String refID)
String	checkCyclicPositionReference(Position position, String refID)
String	checkCyclicRoleReference(Role role, String refID)
void	delCapability(Capability c)
void	delNonHumanCategory(NonHumanCategory r)
void	delNonHumanResource(NonHumanResource r)
void	delOrgGroup(OrgGroup o)
void	delParticipant(Participant p)
void	delPosition(Position p)
void	delRole(Role r)
void	freeResource(String caseID, String id)
HashSet<Capability>	getCapabilities()
String	getCapabilitiesAsXML()
Capability	getCapability(String cid)
Capability	getCapabilityByLabel(String label)
Map<String,String>	getCapabilityIdentifiers()
HashMap<String,Capability>	getCapabilityMap()
Set<Participant>	getCapabilityParticipants(String cid)
String	getCapabilityParticipantsAsXML(String cid)
long	getChangeStamp(ResourceDataSet.ResUnit unit)
DataSource	getDataSource(ResourceDataSet.ResUnit resource)
Participant	getImmediateSupervisor(Participant p) Gets the immediate supervisor of a participant.
Participant	getImmediateSupervisor(String pid) Gets the immediate supervisor of a participant.
long	getLastChangeStamp()
HashSet<NonHumanCategory>	getNonHumanCategories()
String	getNonHumanCategoriesAsXML()
NonHumanCategory	getNonHumanCategory(String cid)
NonHumanCategory	getNonHumanCategoryByName(String name)
Map<String,String>	getNonHumanCategoryIdentifiers()
HashMap<String,NonHumanCategory>	getNonHumanCategoryMap()
String	getNonHumanCategoryNames()
String	getNonHumanCategorySet()
NonHumanResource	getNonHumanResource(String rid)
NonHumanResource	getNonHumanResourceByName(String name)
Map<String,String>	getNonHumanResourceIdentifiers()
HashMap<String,NonHumanResource>	getNonHumanResourceMap()
String	getNonHumanResourceNames()
HashSet<NonHumanResource>	getNonHumanResources()
Set<NonHumanResource>	getNonHumanResources(NonHumanCategory category, String subcategory)
Set<NonHumanResource>	getNonHumanResources(String id, String subcategory)
String	getNonHumanResourcesAsXML()
Set<NonHumanResource>	getNonHumanResourcesByName(String category, String subcategory)
Set<NonHumanSubCategory>	getNonHumanSubCategories()
String	getNonHumanSubCategoriesAsXML()
String	getNonHumanSubCategoriesAsXML(String categoryID)
OrgGroup	getOrgGroup(String oid)
OrgGroup	getOrgGroupByLabel(String label)
Map<String,String>	getOrgGroupIdentifiers()
HashMap<String,OrgGroup>	getOrgGroupMap()
Set<Participant>	getOrgGroupMembers(OrgGroup o)
Set<Participant>	getOrgGroupParticipants(String oid)
HashSet<OrgGroup>	getOrgGroups()
String	getOrgGroupsAsXML()
Participant	getParticipant(String pid)
Set<Capability>	getParticipantCapabilities(String pid)
String	getParticipantCapabilitiesAsXML(String pid)
int	getParticipantCount()
Map<String,String>	getParticipantIdentifiers()
Map<String,String>	getParticipantIdentifiers(ResourceDataSet.Identifier idType)
Map<String,String>	getParticipantIdentifiers(String idStr)
HashMap<String,Participant>	getParticipantMap()
String	getParticipantNames()
Set<Position>	getParticipantPositions(String pid)
String	getParticipantPositionsAsXML(String pid)
Set<Role>	getParticipantRoles(String pid)
String	getParticipantRolesAsXML(String pid)
HashSet<Participant>	getParticipants()
String	getParticipantsAsXML()
Set<Participant>	getParticipantsInDescendantRoles(Role owner)
Set<Participant>	getParticipantsReportingTo(String pid) Gets the complete set of Participants that ultimately report to the position(s) held by a Participant
Set<Participant>	getParticipantsReportingToPosition(Position manager) Gets the set of Participants the ultimately report to the Position passed
Set<Participant>	getParticipantsWithCapability(String capabilityName)
Set<Participant>	getParticipantsWithPosition(String positionName)
Set<Participant>	getParticipantsWithRole(String roleName)
String	getParticpantsWithCapabilityAsXML(String capabilityName)
String	getParticpantsWithPositionAsXML(String positionName)
String	getParticpantsWithRoleAsXML(String roleName)
Position	getPosition(String pid)
Position	getPositionByLabel(String label)
Map<String,String>	getPositionIdentifiers()
HashMap<String,Position>	getPositionMap()
Set<Participant>	getPositionParticipants(String pid)
String	getPositionParticipantsAsXML(String posid)
HashSet<Position>	getPositions()
String	getPositionsAsXML()
AbstractResource	getResource(String id)
ResourceDataSet.ResUnit	getResUnit(String name)
Role	getRole(String rid)
Role	getRoleByName(String roleName)
Map<String,String>	getRoleIdentifiers()
HashMap<String,Role>	getRoleMap()
String	getRoleNames()
Set<Participant>	getRoleParticipants(String rid)
String	getRoleParticipantsAsXML(String rid)
Set<AbstractResource>	getRoleParticipantsWithCapability(String rid, String cid)
HashSet<Role>	getRoles()
String	getRolesAsXML()
boolean	hasDefaultDataSource(ResourceDataSet.ResUnit resource)
void	importCapability(Capability c)
void	importNonHumanCategory(NonHumanCategory r)
void	importNonHumanResource(NonHumanResource r)
void	importOrgGroup(OrgGroup o)
boolean	importParticipant(Participant p)
void	importPosition(Position p)
void	importRole(Role r)
boolean	isDataEditable(ResourceDataSet.ResUnit resource)
boolean	isDataEditable(String resName)
boolean	isExternalOrgDataModsAllowed()
boolean	isKnownCapability(String cid)
boolean	isKnownCapabilityName(String name)
boolean	isKnownNonHumanCategory(NonHumanCategory c)
boolean	isKnownNonHumanCategory(String rid)
boolean	isKnownNonHumanCategoryName(String name)
boolean	isKnownNonHumanResource(NonHumanResource r)
boolean	isKnownNonHumanResource(String rid)
boolean	isKnownNonHumanResourceName(String name)
boolean	isKnownOrgGroup(String oid)
boolean	isKnownOrgGroupName(String name)
boolean	isKnownParticipant(Participant p)
boolean	isKnownParticipant(String pid)
boolean	isKnownPosition(String pid)
boolean	isKnownPositionName(String name)
boolean	isKnownRole(Role r)
boolean	isKnownRole(String rid)
boolean	isKnownRoleName(String name)
boolean	isUserAuthenticationExternal()
boolean	logResourceBusy(String caseID, String id, boolean isBusy)
void	putCapability(Capability c)
void	putNonHumanCategory(NonHumanCategory r)
void	putNonHumanResource(NonHumanResource r)
void	putOrgGroup(OrgGroup o)
void	putParticipant(Participant p)
void	putPosition(Position p)
void	putRole(Role r)
void	removeCapability(Capability c)
boolean	removeCapability(String cid)
void	removeNonHumanCategory(NonHumanCategory r)
boolean	removeNonHumanCategory(String rid)
void	removeNonHumanResource(NonHumanResource r)
boolean	removeNonHumanResource(String rid)
void	removeOrgGroup(OrgGroup o)
boolean	removeOrgGroup(String oid)
boolean	removeParticipant(Participant p)
void	removePosition(Position p)
boolean	removePosition(String pid)
void	removeRole(Role r)
boolean	removeRole(String rid)
Set<String>	resolveParticipantIds(String anyID)
String	resolveParticipantIdsAsXML(String anyID)
Set<Participant>	resolveParticipants(String anyID)
void	setAllowExternalOrgDataMods(boolean allow)
void	setCapabilities(HashMap<String,Capability> capabilities, DataSource source)
void	setDataSource(ResourceDataSet.ResUnit resource, DataSource source)
void	setExternalUserAuthentication(boolean externalAuth)
void	setNonHumanCategories(HashMap<String,NonHumanCategory> resources, DataSource source)
void	setNonHumanResources(HashMap<String,NonHumanResource> resources, DataSource source)
void	setOrgGroups(HashMap<String,OrgGroup> groups, DataSource source)
void	setParticipants(HashMap<String,Participant> participants, DataSource source)
void	setPositions(HashMap<String,Position> positions, DataSource source)
void	setRoles(HashMap<String,Role> roles, DataSource source)
void	updateCapability(Capability c)
void	updateNonHumanCategory(NonHumanCategory r)
void	updateNonHumanResource(NonHumanResource r)
void	updateOrgGroup(OrgGroup o)
boolean	updateParticipant(Participant p)
void	updatePosition(Position p)
void	updateResource(AbstractResource r)
void	updateResourceAttribute(Object obj)
void	updateRole(Role r)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceDataSet

public ResourceDataSet(DataSource source)

Method Detail

setAllowExternalOrgDataMods

public void setAllowExternalOrgDataMods(boolean allow)

isExternalOrgDataModsAllowed

public boolean isExternalOrgDataModsAllowed()

isDataEditable

public boolean isDataEditable(ResourceDataSet.ResUnit resource)

isDataEditable

public boolean isDataEditable(String resName)

setExternalUserAuthentication

public void setExternalUserAuthentication(boolean externalAuth)

isUserAuthenticationExternal

public boolean isUserAuthenticationExternal()

setDataSource

public void setDataSource(ResourceDataSet.ResUnit resource,
                          DataSource source)

getDataSource

public DataSource getDataSource(ResourceDataSet.ResUnit resource)

hasDefaultDataSource

public boolean hasDefaultDataSource(ResourceDataSet.ResUnit resource)

getResUnit

public ResourceDataSet.ResUnit getResUnit(String name)

getChangeStamp

public long getChangeStamp(ResourceDataSet.ResUnit unit)

getLastChangeStamp

public long getLastChangeStamp()

setParticipants

public void setParticipants(HashMap<String,Participant> participants,
                            DataSource source)

setRoles

public void setRoles(HashMap<String,Role> roles,
                     DataSource source)

setCapabilities

public void setCapabilities(HashMap<String,Capability> capabilities,
                            DataSource source)

setPositions

public void setPositions(HashMap<String,Position> positions,
                         DataSource source)

setOrgGroups

public void setOrgGroups(HashMap<String,OrgGroup> groups,
                         DataSource source)

setNonHumanResources

public void setNonHumanResources(HashMap<String,NonHumanResource> resources,
                                 DataSource source)

setNonHumanCategories

public void setNonHumanCategories(HashMap<String,NonHumanCategory> resources,
                                  DataSource source)

augmentDataSourceAsRequired

public void augmentDataSourceAsRequired()

putParticipant

public void putParticipant(Participant p)

putCapability

public void putCapability(Capability c)

putRole

public void putRole(Role r)

putPosition

public void putPosition(Position p)

putOrgGroup

public void putOrgGroup(OrgGroup o)

putNonHumanResource

public void putNonHumanResource(NonHumanResource r)

putNonHumanCategory

public void putNonHumanCategory(NonHumanCategory r)

delParticipant

public void delParticipant(Participant p)

delRole

public void delRole(Role r)

delCapability

public void delCapability(Capability c)

delPosition

public void delPosition(Position p)

delOrgGroup

public void delOrgGroup(OrgGroup o)

delNonHumanResource

public void delNonHumanResource(NonHumanResource r)

delNonHumanCategory

public void delNonHumanCategory(NonHumanCategory r)

addParticipant

public String addParticipant(Participant p)

addRole

public String addRole(Role r)

addCapability

public String addCapability(Capability c)

addPosition

public String addPosition(Position p)

addOrgGroup

public String addOrgGroup(OrgGroup o)

addNonHumanResource

public String addNonHumanResource(NonHumanResource r)

addNonHumanCategory

public String addNonHumanCategory(NonHumanCategory c)

importParticipant

public boolean importParticipant(Participant p)

importRole

public void importRole(Role r)

importCapability

public void importCapability(Capability c)

importPosition

public void importPosition(Position p)

importOrgGroup

public void importOrgGroup(OrgGroup o)

importNonHumanResource

public void importNonHumanResource(NonHumanResource r)

importNonHumanCategory

public void importNonHumanCategory(NonHumanCategory r)

updateResource

public void updateResource(AbstractResource r)

updateParticipant

public boolean updateParticipant(Participant p)

updateResourceAttribute

public void updateResourceAttribute(Object obj)

updateRole

public void updateRole(Role r)

updateCapability

public void updateCapability(Capability c)

updatePosition

public void updatePosition(Position p)

updateOrgGroup

public void updateOrgGroup(OrgGroup o)

updateNonHumanResource

public void updateNonHumanResource(NonHumanResource r)

updateNonHumanCategory

public void updateNonHumanCategory(NonHumanCategory r)

removeParticipant

public boolean removeParticipant(Participant p)

removeRole

public void removeRole(Role r)

removeCapability

public void removeCapability(Capability c)

removePosition

public void removePosition(Position p)

removeOrgGroup

public void removeOrgGroup(OrgGroup o)

removeNonHumanResource

public void removeNonHumanResource(NonHumanResource r)

removeNonHumanCategory

public void removeNonHumanCategory(NonHumanCategory r)

removeRole

public boolean removeRole(String rid)

removeCapability

public boolean removeCapability(String cid)

removePosition

public boolean removePosition(String pid)

removeOrgGroup

public boolean removeOrgGroup(String oid)

removeNonHumanResource

public boolean removeNonHumanResource(String rid)

removeNonHumanCategory

public boolean removeNonHumanCategory(String rid)

getResource

public AbstractResource getResource(String id)

getParticipant

public Participant getParticipant(String pid)

getRole

public Role getRole(String rid)

getCapability

public Capability getCapability(String cid)

getPosition

public Position getPosition(String pid)

getOrgGroup

public OrgGroup getOrgGroup(String oid)

getNonHumanResource

public NonHumanResource getNonHumanResource(String rid)

getNonHumanCategory

public NonHumanCategory getNonHumanCategory(String cid)

getParticipants

public HashSet<Participant> getParticipants()

getRoles

public HashSet<Role> getRoles()

getPositions

public HashSet<Position> getPositions()

getCapabilities

public HashSet<Capability> getCapabilities()

getOrgGroups

public HashSet<OrgGroup> getOrgGroups()

getNonHumanResources

public HashSet<NonHumanResource> getNonHumanResources()

getNonHumanCategories

public HashSet<NonHumanCategory> getNonHumanCategories()

getNonHumanSubCategories

public Set<NonHumanSubCategory> getNonHumanSubCategories()

getParticipantMap

public HashMap<String,Participant> getParticipantMap()

getRoleMap

public HashMap<String,Role> getRoleMap()

getPositionMap

public HashMap<String,Position> getPositionMap()

getCapabilityMap

public HashMap<String,Capability> getCapabilityMap()

getOrgGroupMap

public HashMap<String,OrgGroup> getOrgGroupMap()

getNonHumanResourceMap

public HashMap<String,NonHumanResource> getNonHumanResourceMap()

getNonHumanCategoryMap

public HashMap<String,NonHumanCategory> getNonHumanCategoryMap()

getParticipantIdentifiers

public Map<String,String> getParticipantIdentifiers()

getParticipantIdentifiers

public Map<String,String> getParticipantIdentifiers(String idStr)

getParticipantIdentifiers

public Map<String,String> getParticipantIdentifiers(ResourceDataSet.Identifier idType)

getRoleIdentifiers

public Map<String,String> getRoleIdentifiers()

getPositionIdentifiers

public Map<String,String> getPositionIdentifiers()

getCapabilityIdentifiers

public Map<String,String> getCapabilityIdentifiers()

getOrgGroupIdentifiers

public Map<String,String> getOrgGroupIdentifiers()

getNonHumanResourceIdentifiers

public Map<String,String> getNonHumanResourceIdentifiers()

getNonHumanCategoryIdentifiers

public Map<String,String> getNonHumanCategoryIdentifiers()

getNonHumanSubCategoriesAsXML

public String getNonHumanSubCategoriesAsXML(String categoryID)

getNonHumanCategorySet

public String getNonHumanCategorySet()

getParticipantCount

public int getParticipantCount()

getRoleByName

public Role getRoleByName(String roleName)

getPositionByLabel

public Position getPositionByLabel(String label)

getOrgGroupByLabel

public OrgGroup getOrgGroupByLabel(String label)

getCapabilityByLabel

public Capability getCapabilityByLabel(String label)

getNonHumanResourceByName

public NonHumanResource getNonHumanResourceByName(String name)

getNonHumanCategoryByName

public NonHumanCategory getNonHumanCategoryByName(String name)

getNonHumanResources

public Set<NonHumanResource> getNonHumanResources(NonHumanCategory category,
                                                  String subcategory)

getNonHumanResources

public Set<NonHumanResource> getNonHumanResources(String id,
                                                  String subcategory)

getNonHumanResourcesByName

public Set<NonHumanResource> getNonHumanResourcesByName(String category,
                                                        String subcategory)

isKnownRoleName

public boolean isKnownRoleName(String name)

isKnownCapabilityName

public boolean isKnownCapabilityName(String name)

isKnownPositionName

public boolean isKnownPositionName(String name)

isKnownOrgGroupName

public boolean isKnownOrgGroupName(String name)

isKnownNonHumanResourceName

public boolean isKnownNonHumanResourceName(String name)

isKnownNonHumanCategoryName

public boolean isKnownNonHumanCategoryName(String name)

isKnownParticipant

public boolean isKnownParticipant(Participant p)

isKnownParticipant

public boolean isKnownParticipant(String pid)

isKnownRole

public boolean isKnownRole(Role r)

isKnownRole

public boolean isKnownRole(String rid)

isKnownCapability

public boolean isKnownCapability(String cid)

isKnownPosition

public boolean isKnownPosition(String pid)

isKnownOrgGroup

public boolean isKnownOrgGroup(String oid)

isKnownNonHumanResource

public boolean isKnownNonHumanResource(NonHumanResource r)

isKnownNonHumanResource

public boolean isKnownNonHumanResource(String rid)

isKnownNonHumanCategory

public boolean isKnownNonHumanCategory(NonHumanCategory c)

isKnownNonHumanCategory

public boolean isKnownNonHumanCategory(String rid)

getParticipantNames

public String getParticipantNames()

getRoleNames

public String getRoleNames()

getNonHumanResourceNames

public String getNonHumanResourceNames()

getNonHumanCategoryNames

public String getNonHumanCategoryNames()

getParticipantRoles

public Set<Role> getParticipantRoles(String pid)

getParticipantPositions

public Set<Position> getParticipantPositions(String pid)

getParticipantCapabilities

public Set<Capability> getParticipantCapabilities(String pid)

getRoleParticipants

public Set<Participant> getRoleParticipants(String rid)

getOrgGroupParticipants

public Set<Participant> getOrgGroupParticipants(String oid)

getRoleParticipantsWithCapability

public Set<AbstractResource> getRoleParticipantsWithCapability(String rid,
                                                               String cid)

getCapabilityParticipants

public Set<Participant> getCapabilityParticipants(String cid)

getPositionParticipants

public Set<Participant> getPositionParticipants(String pid)

getParticipantsWithRole

public Set<Participant> getParticipantsWithRole(String roleName)

getParticipantsWithPosition

public Set<Participant> getParticipantsWithPosition(String positionName)

getParticipantsWithCapability

public Set<Participant> getParticipantsWithCapability(String capabilityName)

getOrgGroupMembers

public Set<Participant> getOrgGroupMembers(OrgGroup o)

resolveParticipants

public Set<Participant> resolveParticipants(String anyID)

resolveParticipantIds

public Set<String> resolveParticipantIds(String anyID)

resolveParticipantIdsAsXML

public String resolveParticipantIdsAsXML(String anyID)

getParticipantsReportingTo

public Set<Participant> getParticipantsReportingTo(String pid)

Gets the complete set of Participants that ultimately report to the position(s) held by a Participant

Parameters:

pid - the id of the 'manager' Participant

Returns:

the set of Particpants 'managed' by this Participant

getParticipantsReportingToPosition

public Set<Participant> getParticipantsReportingToPosition(Position manager)

Gets the set of Participants the ultimately report to the Position passed

Parameters:

manager - the 'manager' Position

Returns:

the set of Particpants 'managed' by this Position

getImmediateSupervisor

public Participant getImmediateSupervisor(String pid)

Gets the immediate supervisor of a participant. If the participant holds multiple positions, and therefore has multiple supervisors, one is returned as a random selection.

Parameters:

pid - the id of the participant to get the supervisor of

Returns:

the Participant who is the supervisor of the pid passed, or null if there is no supervisor.

getImmediateSupervisor

public Participant getImmediateSupervisor(Participant p)

Gets the immediate supervisor of a participant. If the participant holds multiple positions, and therefore has multiple supervisors, one is returned as a random selection.

Parameters:

p - the participant to get the supervisor of

Returns:

the Participant who is the supervisor of the pid passed, or null if there is no supervisor.

getParticipantsInDescendantRoles

public Set<Participant> getParticipantsInDescendantRoles(Role owner)

getParticipantsAsXML

public String getParticipantsAsXML()

getRolesAsXML

public String getRolesAsXML()

getCapabilitiesAsXML

public String getCapabilitiesAsXML()

getPositionsAsXML

public String getPositionsAsXML()

getOrgGroupsAsXML

public String getOrgGroupsAsXML()

getNonHumanResourcesAsXML

public String getNonHumanResourcesAsXML()

getNonHumanSubCategoriesAsXML

public String getNonHumanSubCategoriesAsXML()

getNonHumanCategoriesAsXML

public String getNonHumanCategoriesAsXML()

getParticipantRolesAsXML

public String getParticipantRolesAsXML(String pid)

getParticipantPositionsAsXML

public String getParticipantPositionsAsXML(String pid)

getParticipantCapabilitiesAsXML

public String getParticipantCapabilitiesAsXML(String pid)

getParticpantsWithRoleAsXML

public String getParticpantsWithRoleAsXML(String roleName)

getRoleParticipantsAsXML

public String getRoleParticipantsAsXML(String rid)

getParticpantsWithPositionAsXML

public String getParticpantsWithPositionAsXML(String positionName)

getPositionParticipantsAsXML

public String getPositionParticipantsAsXML(String posid)

getParticpantsWithCapabilityAsXML

public String getParticpantsWithCapabilityAsXML(String capabilityName)

getCapabilityParticipantsAsXML

public String getCapabilityParticipantsAsXML(String cid)

castToParticipantSet

public Set<Participant> castToParticipantSet(Set<AbstractResource> resources)

checkCyclicAttributeReference

public String checkCyclicAttributeReference(AbstractResourceAttribute resource,
                                            String parentID)

checkCyclicRoleReference

public String checkCyclicRoleReference(Role role,
                                       String refID)

checkCyclicPositionReference

public String checkCyclicPositionReference(Position position,
                                           String refID)

checkCyclicOrgGroupReference

public String checkCyclicOrgGroupReference(OrgGroup orgGroup,
                                           String refID)

logResourceBusy

public boolean logResourceBusy(String caseID,
                               String id,
                               boolean isBusy)

freeResource

public void freeResource(String caseID,
                         String id)