org.openepics.cable.services

Class CableService

java.lang.Object

org.openepics.cable.services.CableService

public class CableService
extends Object

CableService is the service layer that handles individual cable operations.

Author:

Sunil Sah, Marcel Salmic

Constructor Summary

Constructors

Constructor and Description
CableService()

Method Summary

Modifier and Type	Method and Description
List<String>	cablesByName(String namePart, int limit) Helps listing cable names for UI autocomplete method.
Cable	createCable(CableParams newCable) Creates a cable in the database and returns it.
List<Cable>	createCables(Iterable<Cable> cables, String userId, boolean sendNotification) Creates a bunch of cables in the database and returns them.
boolean	deleteCable(Cable cable, String userId) Marks the cable deleted in the database.
int	deleteCables(Iterable<Cable> cables, String userId) Marks the cables deleted in the database.
protected String	escapeDbString(String dbString) Escapes the characters that have a special meaning in the database LIKE query, '%' and '_'.
protected String	escapeDbStringRegexlike(String dbString) Escapes the characters that have a special meaning in the database LIKE query, '%' and '_'.
boolean	getAndFbsTagUpdateCables(int start, int size, String userId, Map<String,FbsElement> mappingsCableNameToFbsElement, Map<String,FbsElement> mappingsEssNameToFbsElement, Map<String,FbsElement> mappingsIdToFbsElement, Map<String,FbsElement> mappingsTagToFbsElement, Map<String,List<NotificationDTO>> mapOwnersCablesUnexpectedChanges) Retrieves cables and updates FBS tag mappings in one transaction to ensure no other changes happen in the mean time.
boolean	getAndValidateCables(int start, int size, String userId) Retrieves cables and validates them in one transaction to ensure no other changes happen in the mean time.
Cable	getCableById(Long id) Returns a cable with the specified cable id.
Cable	getCableByName(String name) Returns a cable with the specified cable name.
Cable	getCableByName(String name, Boolean detached) Returns a cable with the specified cable name.
List<Cable>	getCableEndpoints(Query customQuery) Returns minimal data on cables
List<Cable>	getCables()
List<Cable>	getCables(String system, String subsystem) Returns a list of cables associated with the specified parameters.
List<Cable>	getCables(String system, String subsystem, String installationPackage) Returns a list of cables associated with the specified parameters.
List<Cable>	getCablesByName(Iterable<String> names, Boolean detached, boolean getDeleted) Returns a list of cables with the specified names.
List<Cable>	getFilteredCablesByRegExp(List<CableColumn> fields, String regExp) Returns a list of cables filtered by regural expression.
LazyService<Cable>	getLazyService()
long	getRowCount(Map<String,Object> filters, Query customQuery) Returns the number of elements to be included in the table.
Cable	reuseCable(ReuseCableDetails cableDetails) Validates parameter, and reuses cable.
boolean	updateCable(Cable cable, Cable oldCable, String userId, boolean sendNotification) Updates the attributes on the given cable.
int	updateCables(Iterable<Cable> cables, Iterable<Cable> oldCables, String userId, boolean sendNotification) Updates the attributes on the given cables.
void	updateFbsTagMappings(String userId, Iterable<Cable> cables, Map<String,FbsElement> mappingsCableNameToFbsElement, Map<String,FbsElement> mappingsEssNameToFbsElement, Map<String,FbsElement> mappingsIdToFbsElement, Map<String,FbsElement> mappingsTagToFbsElement, Map<String,List<NotificationDTO>> mapOwnersCablesUnexpectedChanges) Update FBS tag mappings for cables.
void	updateValidity(String userId, Cable cable) Updates the validity of the cable.
void	validateCables(String userId, Iterable<Cable> cables) Validates the consistency of cable data and updates the data and/or status.

Methods inherited from class java.lang.Object

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

Constructor Detail

CableService

public CableService()

Method Detail

getLazyService

public LazyService<Cable> getLazyService()

getCables

public List<Cable> getCables()

Returns:

a list of all cables

getFilteredCablesByRegExp

public List<Cable> getFilteredCablesByRegExp(List<CableColumn> fields,
                                             String regExp)

Returns a list of cables filtered by regural expression.

Parameters:

fields - filter fields

regExp - filter regular expression

Returns:

a list of cables filtered by regular expression.

getCableByName

public Cable getCableByName(String name,
                            Boolean detached)

Returns a cable with the specified cable name.

Parameters:

name - the cable name (example 12A012345)

detached - boolean indicating if the cable should be detached from the database

Returns:

the cable, or null if the cable with such name cannot be found

getCableByName

public Cable getCableByName(String name)

Returns a cable with the specified cable name.

Parameters:

name - the cable name (example 12A012345)

Returns:

the cable, or null if the cable with such name cannot be found

getCables

public List<Cable> getCables(String system,
                             String subsystem)

Returns a list of cables associated with the specified parameters. Method available for report purposes.

Note:

• deleted cables not considered
• exact match for parameters

Parameters:

system - system

subsystem - subsystem

Returns:

a list of cables

getCables

public List<Cable> getCables(String system,
                             String subsystem,
                             String installationPackage)

Returns a list of cables associated with the specified parameters. Method available for report purposes.

Note:

• deleted cables not considered
• exact match for parameters

Parameters:

system - system

subsystem - subsystem

installationPackage - installation package

Returns:

a list of cables

getCablesByName

public List<Cable> getCablesByName(Iterable<String> names,
                                   Boolean detached,
                                   boolean getDeleted)

Returns a list of cables with the specified names. Cables with invalid names are skipped. Also gets all cable lazy fetched fields eagerly. If getDeleted is true also returns deleted cables else only non-deleted ones.

Parameters:

names - the cable names

detached - a boolean indicating if the cables should be detached from the database

getDeleted - if true returns all cables, if false only non-deleted

Returns:

the cables

cablesByName

public List<String> cablesByName(String namePart,
                                 int limit)

Helps listing cable names for UI autocomplete method. List size will be limited according to limit parameter value. Names will be ordered ASC! If namePart is empty then first few names will be listed

Parameters:

namePart - the part of the cable name that has to be looked for in the DB

limit - size limit for the response list

Returns:

list of cable names according to parameter order by name ASC

reuseCable

public Cable reuseCable(ReuseCableDetails cableDetails)

Validates parameter, and reuses cable. (Creates new cable with same parameters, just different seqNumber, sets Status to NOT IN USE, and sets the original cable-parameters according to parameter) Algorithm behind reusing a cable: 1. Check if ORIGINAL cable available in DB 2. Create NEW cable with same parameters as ORIGINAL has (it will have different seqNumber) 3. Set NEW cable Status to NOT IN USE 4. Set the ORIGINAL cable CableType, and Status to what the user defined to be 5. Save the NEW, and ORIGINAL cable to the DB, and generate History entry If exception occurs between any of the steps, the DB will rollback, which means there will be no "partially created" objects With this method there is no need to swap seqNumbers

Parameters:

cableDetails - new value for cable that has to be re-used

Returns:

the newly created cable

Throws:

RuntimeException - when cable name is empty; cable not found, or DB error happened

getCableById

public Cable getCableById(Long id)

Returns a cable with the specified cable id.

Parameters:

id - the cable id

Returns:

the cable, or null if the cable with such id cannot be found

createCables

public List<Cable> createCables(Iterable<Cable> cables,
                                String userId,
                                boolean sendNotification)

Creates a bunch of cables in the database and returns them.

Parameters:

cables - cables to create in database

userId - user creating cables

sendNotification - boolean indicating if notification regarding cable status should be send

Returns:

the list of cables retrieved from the database

createCable

public Cable createCable(CableParams newCable)

Creates a cable in the database and returns it.

Parameters:

newCable - the parameters of the cable that has to be stored

Returns:

the created cable

updateCables

public int updateCables(Iterable<Cable> cables,
                        Iterable<Cable> oldCables,
                        String userId,
                        boolean sendNotification)

Updates the attributes on the given cables.

Parameters:

cables - the cables with modified attributes to save to the database.

oldCables - the cables before modification. Should be in the same order as in cables. Also needs to be of the same size as cables.

userId - username of user updating the cables, for history record

sendNotification - boolean indicating if notification regarding cable status should be send

Returns:

number of updated cables

updateCable

public boolean updateCable(Cable cable,
                           Cable oldCable,
                           String userId,
                           boolean sendNotification)

Updates the attributes on the given cable.

Parameters:

cable - the cable with modified attributes to save to the database

oldCable - the cable before modification

userId - username of user updating the cable, for history record

sendNotification - boolean indicating if notification regarding cable status should be send

Returns:

true if that cable was updated, false if the cable was not updated

deleteCables

public int deleteCables(Iterable<Cable> cables,
                        String userId)

Marks the cables deleted in the database.

Parameters:

cables - the cables to delete

userId - username of user deleting the cables, for history record

Returns:

number of deleted cables

deleteCable

public boolean deleteCable(Cable cable,
                           String userId)

Marks the cable deleted in the database.

Parameters:

cable - the cable to delete

userId - username of user deleting the cable, for history record

Returns:

true if the cable was deleted, false if the cable was already deleted

getAndFbsTagUpdateCables

public boolean getAndFbsTagUpdateCables(int start,
                                        int size,
                                        String userId,
                                        Map<String,FbsElement> mappingsCableNameToFbsElement,
                                        Map<String,FbsElement> mappingsEssNameToFbsElement,
                                        Map<String,FbsElement> mappingsIdToFbsElement,
                                        Map<String,FbsElement> mappingsTagToFbsElement,
                                        Map<String,List<NotificationDTO>> mapOwnersCablesUnexpectedChanges)

Retrieves cables and updates FBS tag mappings in one transaction to ensure no other changes happen in the mean time.

Parameters:

start - the number of the starting cable to update

size - amount of cables to update

userId - id of the user invoking update

mappingsCableNameToFbsElement - mappings for cable name to FbsElement

mappingsEssNameToFbsElement - mappings for ESS name to FbsElement

mappingsIdToFbsElement - mappings for id to FbsElement

mappingsTagToFbsElement - mappings for tag to FbsElement

mapOwnersCablesUnexpectedChanges - map with key (ownersstring) and value (list of cable names) to track cables for which values changed unexpectedly in tag mapping update

Returns:

if validation was performed, false if there were no more cables to update

See Also:

getAndValidateCables(int, int, String)

updateFbsTagMappings

public void updateFbsTagMappings(String userId,
                                 Iterable<Cable> cables,
                                 Map<String,FbsElement> mappingsCableNameToFbsElement,
                                 Map<String,FbsElement> mappingsEssNameToFbsElement,
                                 Map<String,FbsElement> mappingsIdToFbsElement,
                                 Map<String,FbsElement> mappingsTagToFbsElement,
                                 Map<String,List<NotificationDTO>> mapOwnersCablesUnexpectedChanges)

Update FBS tag mappings for cables.

Parameters:

userId - id of the user invoking validation

cables - cables to validate

mappingsCableNameToFbsElement - mappings for cable name to FbsElement

mappingsEssNameToFbsElement - mappings for ESS name to FbsElement

mappingsIdToFbsElement - mappings for id to FbsElement

mappingsTagToFbsElement - mappings for tag to FbsElement

mapOwnersCablesUnexpectedChanges - map with key (ownersstring) and value (list of cable names) to track cables for which values changed unexpectedly in tag mapping update

getAndValidateCables

public boolean getAndValidateCables(int start,
                                    int size,
                                    String userId)

Retrieves cables and validates them in one transaction to ensure no other changes happen in the mean time.

Parameters:

start - the number of the starting cable to validate

size - amount of cables to validate

userId - username of the user invoking validation

Returns:

true if validation was performed, false if there were no more cables to validate

validateCables

public void validateCables(String userId,
                           Iterable<Cable> cables)

Validates the consistency of cable data and updates the data and/or status.

Parameters:

userId - id of the user invoking validation

cables - the cables to validate

updateValidity

public void updateValidity(String userId,
                           Cable cable)

Updates the validity of the cable.

Parameters:

userId - id of the user invoking validation

cable - the cable to validate

getCableEndpoints

public List<Cable> getCableEndpoints(Query customQuery)

Returns minimal data on cables

Parameters:

customQuery - customQuery for filtering

Returns:

cables with reduced data

escapeDbString

protected String escapeDbString(String dbString)

Escapes the characters that have a special meaning in the database LIKE query, '%' and '_'.

Parameters:

dbString - the string to escape

Returns:

the escaped string

escapeDbStringRegexlike

protected String escapeDbStringRegexlike(String dbString)

Escapes the characters that have a special meaning in the database LIKE query, '%' and '_'. Note that it is not true regex since not working with lazy load. Instead characters '%' and '_' are used. '%' denotes zero to multiple number of any character. '_' denotes zero or one of any character.

Parameters:

dbString - the string to escape

Returns:

the escaped string

getRowCount

public long getRowCount(@Nullable
                        Map<String,Object> filters,
                        Query customQuery)

Returns the number of elements to be included in the table.

Parameters:

filters - filters to use

customQuery - query to add

Returns:

the number of elements in the table