org.openepics.cable.services

Class ConnectorService

java.lang.Object

org.openepics.cable.services.ConnectorService

public class ConnectorService
extends Object

ConnectorService is the service layer that handles individual connector operations.

Author:

Sunil Sah

Constructor Summary

Constructors

Constructor and Description
ConnectorService()

Method Summary

Modifier and Type	Method and Description
Connector	createConnector(String name, String assemblyInstructions, String description, String type, GenericArtifact dataSheet, List<ConnectorManufacturer> manufacturers, String linkToDatasheet, String userId) Creates connector.
boolean	deleteConnector(Connector connector, String userId) Marks the connector as inactive in the database.
void	detachConnector(Connector connector) Detaches a single connector from entity manager
Connector	getConnector(String name) Returns a Connector with the specified name.
List<Connector>	getConnectors()
List<Connector>	getFilteredConnectors(Collection<ConnectorColumn> fields, String regExp) Returns all connectors for which at least one of the specified fields matches the given regular expression.
List<Connector>	getFilteredConnectors(String customQuery, Query query) Return a list of filtered connectors.
boolean	updateConnector(Connector connector, Connector oldConnector, String userId) Updates the attributes on the given connector.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectorService

public ConnectorService()

Method Detail

getConnectors

public List<Connector> getConnectors()

Returns:

a list of all connectors

getFilteredConnectors

public List<Connector> getFilteredConnectors(String customQuery,
                                             Query query)

Return a list of filtered connectors.

Parameters:

customQuery - custom query for filtering connectors

query - query to update

Returns:

a list of filtered connectors

getFilteredConnectors

public List<Connector> getFilteredConnectors(Collection<ConnectorColumn> fields,
                                             String regExp)

Returns all connectors for which at least one of the specified fields matches the given regular expression.

Parameters:

fields - the list of string fields to check

regExp - regular expression containing only literals, wildcard (*) and single character (?)

Returns:

a list of matching connectors

getConnector

public Connector getConnector(String name)

Returns a Connector with the specified name.

Parameters:

name - name of the connector

Returns:

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

createConnector

public Connector createConnector(String name,
                                 String assemblyInstructions,
                                 String description,
                                 String type,
                                 GenericArtifact dataSheet,
                                 List<ConnectorManufacturer> manufacturers,
                                 String linkToDatasheet,
                                 String userId)

Creates connector.

Parameters:

name - the name of the connector

assemblyInstructions - assembly instructions for the connector

description - description belonging to the connector

type - the type of the connector

dataSheet - datasheet artifact

manufacturers - the manufacturers of this connector

linkToDatasheet - link to datasheet for the connector

userId - username of user creating the connector, for history record

Returns:

a new Connector instance.

updateConnector

public boolean updateConnector(Connector connector,
                               Connector oldConnector,
                               String userId)

Updates the attributes on the given connector.

Parameters:

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

oldConnector - the connector before modification

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

Returns:

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

deleteConnector

public boolean deleteConnector(Connector connector,
                               String userId)

Marks the connector as inactive in the database.

Parameters:

connector - the connector to delete

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

Returns:

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

detachConnector

public void detachConnector(Connector connector)

Detaches a single connector from entity manager

Parameters:

connector - the Connector to detach