com.wandrell.pattern.repository.package-info Maven / Gradle / Ivy
/**
* The MIT License (MIT)
*
* Copyright (c) 2015 the original author or authors.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/**
* Provides interfaces and basic implementations for the repository pattern.
*
* This pattern is similar to a DAO, as it allows accessing data through CRUD
* operations, hiding the source of this data.
*
* It can be hard to find differences between a DAO and a repository, but the
* first is used as an interface between the application and a table on a
* database, while the second is a domain driven pattern, which may or not be
* linked to a database.
*
Interfaces
*
* The {@link com.wandrell.pattern.repository.Repository Repository} offers the
* most basic implementation of this pattern, using the general CRUD operations.
*
* But the {@link com.wandrell.pattern.repository.FilteredRepository
* FilteredRepository} additionally allows acquiring just a subset of data from
* the repository, with the use of the
* {@link com.wandrell.pattern.repository.FilteredRepository#getCollection(Object)
* getCollection} and the
* {@link com.wandrell.pattern.repository.FilteredRepository#getEntity(Object)
* getEntity} methods. Both of them require a filter class, the difference being
* that {@code getCollection} returns a collection of entities, while
* {@code getEntity} returns just a single entity.
*
* Each implementation will take care of which type of object will it use for
* filtering, and how it will apply such filter. But an example is the
* {@link com.wandrell.pattern.repository.QueryData QueryData} interface, which
* stores data for generating queries similar to the SQL ones.
*
Implementations
*
* A basic implementation of the {@code FilteredRepository},
* {@link com.wandrell.pattern.repository.CollectionRepository
* CollectionRepository}, offers a simple and fast way of creating the simplest
* possible repository.
*
* It stores entities inside a {@code Collection}, and filters them through
* Guava classes, specifically it requires a Predicate which the entities to be returned should validate.
*
* Additionally, there is a default implementation of {@code QueryData},
* {@link com.wandrell.pattern.repository.DefaultQueryData DefaultQueryData},
* which just serves to ease using said interface.
*/
package com.wandrell.pattern.repository;