com.dnastack.bob.persistence.api

Interface BeaconDao

All Superinterfaces:

GenericDao<Beacon,String>, Serializable

public interface BeaconDao
extends GenericDao<Beacon,String>

Beacon DAO.

Version:

1.0

Author:

Miroslav Cupak (mirocupak@gmail.com)

Method Summary

Modifier and Type	Method and Description
boolean	addRelationship(Beacon child, Beacon parent) Creates parent-child association.
List<Beacon>	findByAggregation(boolean aggregator) Retrieves beacons by aggregation flag.
Beacon	findByIdAndVisibility(String id, boolean visible) Retrieves a beacon by its ID and visibility.
List<Beacon>	findByIds(Collection<String> ids) Retrieves beacons by their IDs.
List<Beacon>	findByIdsAndVisibility(Collection<String> ids, boolean visible) Retrieves beacons by visibility.
List<Beacon>	findByVisibility(boolean visible) Retrieves beacons by visibility.
Set<Beacon>	findDescendants(Beacon parent, boolean includeAggregators, boolean includeInvisible, boolean includeDisabled, boolean includeSelf) Computes a set of nodes covered by a specific node transitively.
boolean	haveRelationship(Beacon child, Beacon parent) Checks existence of a parent-child association.
boolean	removeRelationship(Beacon child, Beacon parent) Removes parent-child association.

Methods inherited from interface com.dnastack.bob.persistence.api.GenericDao

countAll, delete, findAll, findById, flush, getReferenceById, save, update

Method Detail

findByAggregation

List<Beacon> findByAggregation(boolean aggregator)

Retrieves beacons by aggregation flag.

Parameters:

aggregator - true if looking for aggregating beacons, false if looking for regular beacons

Returns:

collection of beacons

findByVisibility

List<Beacon> findByVisibility(boolean visible)

Retrieves beacons by visibility.

Parameters:

visible - true if looking for visible beacons, false if looking for invisible/anonymous beacons

Returns:

collection of beacons

findByIds

List<Beacon> findByIds(Collection<String> ids)

Retrieves beacons by their IDs.

Parameters:

ids - IDs

Returns:

collection of beacons

findByIdsAndVisibility

List<Beacon> findByIdsAndVisibility(Collection<String> ids,
                                    boolean visible)

Retrieves beacons by visibility.

Parameters:

ids - IDs

visible - true if looking for visible beacons, false if looking for invisible/anonymous beacons

Returns:

collection of beacons

findByIdAndVisibility

Beacon findByIdAndVisibility(String id,
                             boolean visible)

Retrieves a beacon by its ID and visibility.

Parameters:

id - ID

visible - true if looking for visible beacons, false if looking for invisible/anonymous beacons

Returns:

collection of beacons

haveRelationship

boolean haveRelationship(Beacon child,
                         Beacon parent)

Checks existence of a parent-child association.

Parameters:

parent - parent

child - child

Returns:

true if the child did not have that parent already, false otherwise

addRelationship

boolean addRelationship(Beacon child,
                        Beacon parent)

Creates parent-child association.

Parameters:

parent - parent

child - child

Returns:

true if the child did not have that parent already, false otherwise

removeRelationship

boolean removeRelationship(Beacon child,
                           Beacon parent)

Removes parent-child association.

Parameters:

parent - parent

child - child

Returns:

true if the child had that parent already, false otherwise

findDescendants

Set<Beacon> findDescendants(Beacon parent,
                            boolean includeAggregators,
                            boolean includeInvisible,
                            boolean includeDisabled,
                            boolean includeSelf)

Computes a set of nodes covered by a specific node transitively.

Parameters:

parent - node

includeAggregators - true if aggregators should be included in the results

includeInvisible - true if invisible beacons should be included in the results

includeDisabled - true if disabled beacons should be included as well

includeSelf - true if self should be included in the results

Returns:

set of nodes