Package fi.tut.mei.resdescapi.rescatapi

Class ResCatStoImpl_TestWithDummyData

java.lang.Object

fi.tut.mei.resdescapi.rescatapi.ResCatStoImpl

fi.tut.mei.resdescapi.rescatapi.ResCatStoImpl_TestWithDummyData

All Implemented Interfaces:

IIssueActions<ResCatIssue>, ResCatStorageInterface

public class ResCatStoImpl_TestWithDummyData
extends ResCatStoImpl
implements ResCatStorageInterface

This is Dummy implementation for early tests of Resource Catalogue Storage Platform. It contains fixed and static data structure as resource catalogue, which can be utilised for testing the API. Should be finally removed or moved into the test sources.

Author:

Niko Siltala

Nested Class Summary

Nested classes/interfaces inherited from interface fi.tut.mei.resdescapi.rescatapi.ResCatStorageInterface

ResCatStorageInterface.EnumSearchDomainForARD, ResCatStorageInterface.EnumSearchField

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	_ARD_AlwaysExist	ARD that always exists
protected static String	_Capability_AlwaysExist	Capability that always exists
protected static String	_Capability_NeverExist	Capability that never exists
protected static String	_ITEM_NEVER_EXISTS	never existing item
protected static String	_Prof_AlwaysExist	Profile that always exists
protected static String	_RD_AlwaysExist	RD that always exists

Fields inherited from class fi.tut.mei.resdescapi.rescatapi.ResCatStoImpl

_ardList, _rdList

Constructor Summary

Constructors

Constructor	Description
ResCatStoImpl_TestWithDummyData()

Method Summary

Modifier and Type	Method	Description
AbstractResourceDesc	getARDStructureFromStorage(String ardId)	Gets Abstract Resource Description (ARD) by given ARD Id.
int	getNumberOfArds()	Get number of ARDs in this repository.
int	getNumberOfRds()	Get number of RDs in this repository.
ResourceDescription	getRDSkeleton_ARDandProfile(String ARDId, String ProfileId)	Creates a RDSkeleton, which is a customised RDTemplate, by given ARD and Profile.
ResourceDescription	getRDStructureFromStorage(String rdId)	Gets Resource Description (RD) by given RD Id.
String	getRepositoryReport()	Creates and retrieves report of this repository storage.
boolean	hasARDAndProfile(String ardId, String profileId)	Has this repository a specific ARD (and Profile) or not?
boolean	hasRD(String rdId)	Has this repository a specific RD or not?
boolean	pushARDContentToStorage(String ardContentData, String filename, boolean overwrite)	Pushes given ARD to storage and updates the possible search index with this information.
boolean	pushARDStructureToStorage(AbstractResourceDesc ardObj, String filename, boolean overwrite)	Pushes given ARD to storage and updates the possible search index with this information.
boolean	pushRDContentToStorage(String rdContentData, String filename, boolean overwrite)	Pushes given RD to storage and updates the possible search index with this information.
boolean	pushRDStructureToStorage(ResourceDescription rdObj, String filename, boolean overwrite)	Pushes given RD to storage and updates the possible search index with this information.
Set<ARDAndProfInfo>	viewARDAndProfiles_All()	Gets all ARDs in the storage by element's own descriptive data.
Set<ARDAndProfInfo>	viewARDAndProfiles_Capability(String capability, ResCatStorageInterface.EnumSearchField searchField, Util.EnumSearchType searchType, ResCatStorageInterface.EnumSearchDomainForARD searchDomain)	Searches matching ARDs or ARD's Profiles by capability data.
Set<ARDAndProfInfo>	viewARDAndProfiles_CapabilityParameter(String capability, List<String> parameters, List<String> values, ResCatStorageInterface.EnumSearchField searchField, Util.EnumSearchType searchType, ResCatStorageInterface.EnumSearchDomainForARD searchDomain)	Searches matching ARDs or ARD's Profiles by capability and its parameters data.
Set<ARDAndProfInfo>	viewARDAndProfiles_Category(String category, ResCatStorageInterface.EnumSearchField searchField, Util.EnumSearchType searchType, ResCatStorageInterface.EnumSearchDomainForARD searchDomain)	Searches matching ARDs or ARD's Profiles by category data.
Set<ARDAndProfInfo>	viewARDAndProfiles_Description(String desc, ResCatStorageInterface.EnumSearchField searchField, Util.EnumSearchType searchType, ResCatStorageInterface.EnumSearchDomainForARD searchDomain)	Searches matching ARDs or ARD's Profiles by element's own descriptive data.
Set<ARDAndProfInfo>	viewARDAndProfiles_Interface(String ifStd, ResCatStorageInterface.EnumSearchField searchField, Util.EnumSearchType searchType, ResCatStorageInterface.EnumSearchDomainForARD searchDomain)	Searches matching ARDs or ARD's Profiles by interface standard data.
Set<ARDAndProfInfo>	viewARDAndProfiles_Property(String property, ResCatStorageInterface.EnumSearchField searchField, Util.EnumSearchType searchType, ResCatStorageInterface.EnumSearchDomainForARD searchDomain)	Searches matching ARDs or ARD's Profiles by property data.
Set<RDInfo>	viewRDs_All()	Gets all RDs in the storage by element's own descriptive data.
Set<RDInfo>	viewRDs_Capability(String capability, ResCatStorageInterface.EnumSearchField searchField, Util.EnumSearchType searchType)	Searches matching RDs by capability data.
Set<RDInfo>	viewRDs_CapabilityParameter(String capability, List<String> parameters, List<String> values, ResCatStorageInterface.EnumSearchField searchField, Util.EnumSearchType searchType)	Searches matching RDs by capability and its parameters data.
Set<RDInfo>	viewRDs_Category(String category, ResCatStorageInterface.EnumSearchField searchField, Util.EnumSearchType searchType)	Searches matching RDs by category data.
Set<RDInfo>	viewRDs_Description(String desc, ResCatStorageInterface.EnumSearchField searchField, Util.EnumSearchType searchType)	Searches matching RDs by element's own descriptive data.
Set<RDInfo>	viewRDs_Interface(String ifStd, ResCatStorageInterface.EnumSearchField searchField, Util.EnumSearchType searchType)	Searches matching RDs by interface standard data.
Set<RDInfo>	viewRDs_Property(String property, ResCatStorageInterface.EnumSearchField searchField, Util.EnumSearchType searchType)	Searches matching RDs by property data.

Methods inherited from class fi.tut.mei.resdescapi.rescatapi.ResCatStoImpl

addIssue, clearIssues, equals, getAllStored_Capabilities_ARD, getAllStored_Capabilities_RD, getAllStored_Categories_ARD, getAllStored_Categories_RD, getAllStored_Interfaces_ARD, getAllStored_Interfaces_RD, getAllStored_Properties_ARD, getAllStored_Properties_RD, getIssues, getResourceCatalogueId, getResourceCatalogueName, hashCode, hasIssues, isWritable, setResourceCatalogueId, setResourceCatalogueName, setWritable

Methods inherited from class java.lang.Object

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

Methods inherited from interface fi.tut.mei.resdescapi.rescatapi.ResCatStorageInterface

getAllStored_Capabilities_ARD, getAllStored_Capabilities_RD, getAllStored_Categories_ARD, getAllStored_Categories_RD, getAllStored_Interfaces_ARD, getAllStored_Interfaces_RD, getAllStored_Properties_ARD, getAllStored_Properties_RD, getResourceCatalogueId, getResourceCatalogueName, isWritable, setResourceCatalogueId, setResourceCatalogueName, setWritable

Field Detail

_ITEM_NEVER_EXISTS

protected static final String _ITEM_NEVER_EXISTS

never existing item

See Also:

Constant Field Values

_Capability_NeverExist

protected static final String _Capability_NeverExist

Capability that never exists

See Also:

Constant Field Values

_Capability_AlwaysExist

protected static final String _Capability_AlwaysExist

Capability that always exists

See Also:

Constant Field Values

_ARD_AlwaysExist

protected static final String _ARD_AlwaysExist

ARD that always exists

See Also:

Constant Field Values

_Prof_AlwaysExist

protected static final String _Prof_AlwaysExist

Profile that always exists

See Also:

Constant Field Values

_RD_AlwaysExist

protected static final String _RD_AlwaysExist

RD that always exists

See Also:

Constant Field Values

Constructor Detail

ResCatStoImpl_TestWithDummyData

public ResCatStoImpl_TestWithDummyData()

Method Detail

getNumberOfArds

public int getNumberOfArds()

Description copied from interface: ResCatStorageInterface

Get number of ARDs in this repository.

Specified by:

getNumberOfArds in interface ResCatStorageInterface

Returns:

Number of ARDs in the repository. 0 or larger. Returns also 0 if repository does not exist.

hasARDAndProfile

public boolean hasARDAndProfile(String ardId,
                                String profileId)
                         throws ARDNotExistException,
                                ProfileNotExistException

Description copied from interface: ResCatStorageInterface

Has this repository a specific ARD (and Profile) or not?

Specified by:

hasARDAndProfile in interface ResCatStorageInterface

Parameters:

ardId - ID of an ARD

profileId - ID of a Profile which is looked for. Can be null -> in this case check limits to only ARD ID.

Returns:

true if ARD (or ARD and Profile) is found. false if not.

Throws:

ARDNotExistException - ARD was not found.

ProfileNotExistException - ARD and its specific Profile is not found.

viewARDAndProfiles_All

public Set<ARDAndProfInfo> viewARDAndProfiles_All()

Description copied from interface: ResCatStorageInterface

Gets all ARDs in the storage by element's own descriptive data.

Specified by:

viewARDAndProfiles_All in interface ResCatStorageInterface

Returns:

Set(ARDAndProfInfo) contains a collection of found ARDs and its Profiles. null if no ARDs exist.

viewARDAndProfiles_Description

public Set<ARDAndProfInfo> viewARDAndProfiles_Description(String desc,
                                                          ResCatStorageInterface.EnumSearchField searchField,
                                                          Util.EnumSearchType searchType,
                                                          ResCatStorageInterface.EnumSearchDomainForARD searchDomain)

Description copied from interface: ResCatStorageInterface

Searches matching ARDs or ARD's Profiles by element's own descriptive data.

Specified by:

viewARDAndProfiles_Description in interface ResCatStorageInterface

Parameters:

desc - search string for descriptions

searchField - What field is used for search?

searchType - Search type used for search

searchDomain - What is the ARD's internal search domain?

Returns:

Set(ARDAndProfInfo) contains a collection of found ARDs and its matching Profiles. null if no matches are found.

viewARDAndProfiles_Category

public Set<ARDAndProfInfo> viewARDAndProfiles_Category(String category,
                                                       ResCatStorageInterface.EnumSearchField searchField,
                                                       Util.EnumSearchType searchType,
                                                       ResCatStorageInterface.EnumSearchDomainForARD searchDomain)

Description copied from interface: ResCatStorageInterface

Searches matching ARDs or ARD's Profiles by category data.

Specified by:

viewARDAndProfiles_Category in interface ResCatStorageInterface

Parameters:

category - search string for categories

searchField - What field is used for search?

searchType - Search type used for search

searchDomain - What is the ARD's internal search domain?

Returns:

Set(ARDAndProfInfo) contains a collection of found ARDs and its matching Profiles. null if no matches are found.

viewARDAndProfiles_Capability

public Set<ARDAndProfInfo> viewARDAndProfiles_Capability(String capability,
                                                         ResCatStorageInterface.EnumSearchField searchField,
                                                         Util.EnumSearchType searchType,
                                                         ResCatStorageInterface.EnumSearchDomainForARD searchDomain)

Description copied from interface: ResCatStorageInterface

Searches matching ARDs or ARD's Profiles by capability data.

Specified by:

viewARDAndProfiles_Capability in interface ResCatStorageInterface

Parameters:

capability - search string for capability

searchField - What field is used for search?

searchType - Search type used for search

searchDomain - What is the ARD's internal search domain?

Returns:

Set(ARDAndProfInfo) contains a collection of found ARDs and its matching Profiles. null if no matches are found.

viewARDAndProfiles_CapabilityParameter

public Set<ARDAndProfInfo> viewARDAndProfiles_CapabilityParameter(String capability,
                                                                  List<String> parameters,
                                                                  List<String> values,
                                                                  ResCatStorageInterface.EnumSearchField searchField,
                                                                  Util.EnumSearchType searchType,
                                                                  ResCatStorageInterface.EnumSearchDomainForARD searchDomain)

Description copied from interface: ResCatStorageInterface

Searches matching ARDs or ARD's Profiles by capability and its parameters data.

Specified by:

viewARDAndProfiles_CapabilityParameter in interface ResCatStorageInterface

Parameters:

capability - search string for capability

parameters - List of parameter information. Meaning of this information depends on searchField.

values - Optional. Can be null. Links values to a parameter on the parameters list. Must be same size and index as parameters list.

searchField - What field is used for the search?

searchType - Search type used for search

Returns:

Set(ARDAndProfInfo) contains a collection of found ARDs and its matching Profiles. null if no matches are found.

viewARDAndProfiles_Interface

public Set<ARDAndProfInfo> viewARDAndProfiles_Interface(String ifStd,
                                                        ResCatStorageInterface.EnumSearchField searchField,
                                                        Util.EnumSearchType searchType,
                                                        ResCatStorageInterface.EnumSearchDomainForARD searchDomain)

Description copied from interface: ResCatStorageInterface

Searches matching ARDs or ARD's Profiles by interface standard data.

Specified by:

viewARDAndProfiles_Interface in interface ResCatStorageInterface

Parameters:

ifStd - search string for interface standards

searchField - What field is used for search?

searchType - Search type used for search

searchDomain - What is the ARD's internal search domain?

Returns:

Set(ARDAndProfInfo) contains a collection of found ARDs and its matching Profiles. null if no matches are found.

viewARDAndProfiles_Property

public Set<ARDAndProfInfo> viewARDAndProfiles_Property(String property,
                                                       ResCatStorageInterface.EnumSearchField searchField,
                                                       Util.EnumSearchType searchType,
                                                       ResCatStorageInterface.EnumSearchDomainForARD searchDomain)

Description copied from interface: ResCatStorageInterface

Searches matching ARDs or ARD's Profiles by property data.

Specified by:

viewARDAndProfiles_Property in interface ResCatStorageInterface

Parameters:

property - search string for properties

searchField - What field is used for search?

searchType - Search type used for search

searchDomain - What is the ARD's internal search domain?

Returns:

Set(ARDAndProfInfo) contains a collection of found ARDs and its matching Profiles. null if no matches are found.

getARDStructureFromStorage

public AbstractResourceDesc getARDStructureFromStorage(String ardId)
                                                throws ARDNotExistException,
                                                       IOException

Description copied from interface: ResCatStorageInterface

Gets Abstract Resource Description (ARD) by given ARD Id.

Specified by:

getARDStructureFromStorage in interface ResCatStorageInterface

Parameters:

ardId - Id of the ARD

Returns:

Abstract Resource Description (ARD) (TODO TBD which object is returned. ARDmodel )

Throws:

ARDNotExistException

IOException

pushARDContentToStorage

public boolean pushARDContentToStorage(String ardContentData,
                                       String filename,
                                       boolean overwrite)
                                throws UserAuthorisationException,
                                       UserHasNotRightsException,
                                       IOException,
                                       ARDAlreadyExistException

Description copied from interface: ResCatStorageInterface

Pushes given ARD to storage and updates the possible search index with this information.

Specified by:

pushARDContentToStorage in interface ResCatStorageInterface

Parameters:

ardContentData - ARD as String

filename - Filename used for storing this resource. Can be null, when system decides the name.

overwrite - True = existing ARD is overwritten

Returns:

true if ARD is successfully stored

Throws:

UserAuthorisationException

UserHasNotRightsException

IOException

ARDAlreadyExistException

pushARDStructureToStorage

public boolean pushARDStructureToStorage(AbstractResourceDesc ardObj,
                                         String filename,
                                         boolean overwrite)
                                  throws UserAuthorisationException,
                                         UserHasNotRightsException,
                                         IOException,
                                         ARDAlreadyExistException

Description copied from interface: ResCatStorageInterface

Pushes given ARD to storage and updates the possible search index with this information.

Specified by:

pushARDStructureToStorage in interface ResCatStorageInterface

Parameters:

ardObj - ARD as Java object model

filename - Filename used for storing this resource. Can be null, when system decides the name.

overwrite - True = existing ARD is overwritten

Returns:

true if ARD is successfully stored

Throws:

UserAuthorisationException

UserHasNotRightsException

IOException

ARDAlreadyExistException

getRDSkeleton_ARDandProfile

public ResourceDescription getRDSkeleton_ARDandProfile(String ARDId,
                                                       String ProfileId)
                                                throws ARDNotExistException,
                                                       ProfileNotExistException,
                                                       IOException,
                                                       Exception

Description copied from interface: ResCatStorageInterface

Creates a RDSkeleton, which is a customised RDTemplate, by given ARD and Profile. This is a valid Resource Description (RD), which the user can start to modify and fill in.

Specified by:

getRDSkeleton_ARDandProfile in interface ResCatStorageInterface

Parameters:

ARDId - Selected Abstract Resource Description(ARD)

ProfileId - Selected Profile inside ARD

Returns:

Resource Description (RD)

Throws:

ARDNotExistException

ProfileNotExistException

IOException

Exception

getNumberOfRds

public int getNumberOfRds()

Description copied from interface: ResCatStorageInterface

Get number of RDs in this repository.

Specified by:

getNumberOfRds in interface ResCatStorageInterface

Returns:

Number of RDs in the repository. 0 or larger. Returns also 0 if repository does not exist.

hasRD

public boolean hasRD(String rdId)
              throws RDNotExistException

Description copied from interface: ResCatStorageInterface

Has this repository a specific RD or not?

Specified by:

hasRD in interface ResCatStorageInterface

Parameters:

rdId - ID of an RD

Returns:

true if RD is found. False if not.

Throws:

RDNotExistException - RD was not found.

viewRDs_All

public Set<RDInfo> viewRDs_All()

Description copied from interface: ResCatStorageInterface

Gets all RDs in the storage by element's own descriptive data.

Specified by:

viewRDs_All in interface ResCatStorageInterface

Returns:

Set(RDInfo) contains a collection of found RDs. null if RDs exists.

viewRDs_Description

public Set<RDInfo> viewRDs_Description(String desc,
                                       ResCatStorageInterface.EnumSearchField searchField,
                                       Util.EnumSearchType searchType)

Description copied from interface: ResCatStorageInterface

Searches matching RDs by element's own descriptive data.

Specified by:

viewRDs_Description in interface ResCatStorageInterface

Parameters:

desc - search string for descriptions

searchField - What field is used for search?

searchType - Search type used for search

Returns:

Set(RDInfo) contains a collection of found RDs. null if no matches are found.

viewRDs_Category

public Set<RDInfo> viewRDs_Category(String category,
                                    ResCatStorageInterface.EnumSearchField searchField,
                                    Util.EnumSearchType searchType)

Description copied from interface: ResCatStorageInterface

Searches matching RDs by category data.

Specified by:

viewRDs_Category in interface ResCatStorageInterface

Parameters:

category - search string for categories

searchField - What field is used for search?

searchType - Search type used for search

Returns:

Set(RDInfo) contains a collection of found RDs. null if no matches are found.

viewRDs_Capability

public Set<RDInfo> viewRDs_Capability(String capability,
                                      ResCatStorageInterface.EnumSearchField searchField,
                                      Util.EnumSearchType searchType)

Description copied from interface: ResCatStorageInterface

Searches matching RDs by capability data.

Specified by:

viewRDs_Capability in interface ResCatStorageInterface

Parameters:

capability - search string for capability

searchField - What field is used for search?

searchType - Search type used for search

Returns:

Set(RDInfo) contains a collection of found RDs. null if no matches are found.

viewRDs_CapabilityParameter

public Set<RDInfo> viewRDs_CapabilityParameter(String capability,
                                               List<String> parameters,
                                               List<String> values,
                                               ResCatStorageInterface.EnumSearchField searchField,
                                               Util.EnumSearchType searchType)

Description copied from interface: ResCatStorageInterface

Searches matching RDs by capability and its parameters data.

Specified by:

viewRDs_CapabilityParameter in interface ResCatStorageInterface

Parameters:

capability - search string for capability

parameters - List of parameter information. Meaning of this information depends on searchField.

values - Optional. Can be null. Links values to a parameter on the parameters list. Must be same size and index as parameters list.

searchField - What field is used for the search?

searchType - Search type used for search

Returns:

Set(RDInfo) contains a collection of found RDs. null if no matches are found.

viewRDs_Interface

public Set<RDInfo> viewRDs_Interface(String ifStd,
                                     ResCatStorageInterface.EnumSearchField searchField,
                                     Util.EnumSearchType searchType)

Description copied from interface: ResCatStorageInterface

Searches matching RDs by interface standard data.

Specified by:

viewRDs_Interface in interface ResCatStorageInterface

Parameters:

ifStd - search string for interface standards

searchField - What field is used for search?

searchType - Search type used for search

Returns:

Set(RDInfo) contains a collection of found RDs. null if no matches are found.

viewRDs_Property

public Set<RDInfo> viewRDs_Property(String property,
                                    ResCatStorageInterface.EnumSearchField searchField,
                                    Util.EnumSearchType searchType)

Description copied from interface: ResCatStorageInterface

Searches matching RDs by property data.

Specified by:

viewRDs_Property in interface ResCatStorageInterface

Parameters:

property - search string for properties

searchField - What field is used for search?

searchType - Search type used for search

Returns:

Set(RDInfo) contains a collection of found RDs. null if no matches are found.

getRDStructureFromStorage

public ResourceDescription getRDStructureFromStorage(String rdId)
                                              throws RDNotExistException,
                                                     IOException,
                                                     Exception

Description copied from interface: ResCatStorageInterface

Gets Resource Description (RD) by given RD Id.

Specified by:

getRDStructureFromStorage in interface ResCatStorageInterface

Parameters:

rdId - Id of the RD

Returns:

Resource Description (RD)

Throws:

RDNotExistException

IOException

Exception

pushRDContentToStorage

public boolean pushRDContentToStorage(String rdContentData,
                                      String filename,
                                      boolean overwrite)
                               throws UserAuthorisationException,
                                      UserHasNotRightsException,
                                      IOException,
                                      RDAlreadyExistException

Description copied from interface: ResCatStorageInterface

Pushes given RD to storage and updates the possible search index with this information.

Specified by:

pushRDContentToStorage in interface ResCatStorageInterface

Parameters:

rdContentData - RD as String

filename - Filename used for storing this resource. Can be null, when system decides the name.

overwrite - True = existing RD is overwritten

Returns:

true if RD is successfully stored

Throws:

UserAuthorisationException

UserHasNotRightsException

IOException

RDAlreadyExistException

pushRDStructureToStorage

public boolean pushRDStructureToStorage(ResourceDescription rdObj,
                                        String filename,
                                        boolean overwrite)
                                 throws UserAuthorisationException,
                                        UserHasNotRightsException,
                                        IOException,
                                        RDAlreadyExistException

Description copied from interface: ResCatStorageInterface

Pushes given RD to storage and updates the possible search index with this information.

Specified by:

pushRDStructureToStorage in interface ResCatStorageInterface

Parameters:

rdObj - RD as Java object model

filename - Filename used for storing this resource. Can be null, when system decides the name.

overwrite - True = existing RD is overwritten

Returns:

true if RD is successfully stored

Throws:

UserAuthorisationException

UserHasNotRightsException

IOException

RDAlreadyExistException

getRepositoryReport

public String getRepositoryReport()

Description copied from interface: ResCatStorageInterface

Creates and retrieves report of this repository storage. Should contain listings of available ARDs and RDs. Each of these is listed at least ID, name and description.

Specified by:

getRepositoryReport in interface ResCatStorageInterface

Returns:

Report in plain text format.