EventsDataset (Tests 0.2.0-SNAPSHOT API)

java.lang.Object
- es.uvigo.esei.dgss.letta.domain.entities.EventsDataset

```
public final class EventsDataset
extends Object
```
Utility test class that contains a set of Event entities. This dataset is replicated in the event*.xml dataset files.

Author:

Jesús Álvarez Casanova, Adrián Rodríguez Fariña, Alberto Gutiérrez Jácome

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`events()` An array of twenty-five events that should exist in the database.
`static List<es.uvigo.esei.dgss.letta.domain.entities.Event>`	`eventsAsList()`
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`eventsWithTitleOrDescriptionContaining(String pattern)` An array of `Event` that have in them title or description a pattern provided
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`eventsWithTwoJoinedUsers()` An array of twenty-five events that should exist in the database, and with already joined users (two per event) to each event.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`eventWithId(int id)` Returns the unique `Event` from the `events()` array that has the provided ID.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`eventWithTitle(String title)` Returns an Event from the `events()` array that has the provided title.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`eventWithType(es.uvigo.esei.dgss.letta.domain.entities.EventType type)` Returns an `Event` from the `events()` array that has the provided `type`.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`existentEvent()` Returns an `Event` that should exist in the database.
`static int`	`existentEventId()` Returns the ID of a `Event` that should exist in the database.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`filterEvents(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)` Returns the `events()` that satisfy a given `Predicate`.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`filterEventsWithTwoJoinedUsers(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)` Returns the `eventsWithTwoJoinedUsers()` that satisfy a given `Predicate`.
`static Optional<es.uvigo.esei.dgss.letta.domain.entities.Event>`	`findEvent(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)` Returns an `Optional` holding or not the first found `Event` in `events()` that satisfies a given `Predicate`.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`findEventOrThrow(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)` Returns the first `Event` from `events()` that satisfies the given `Predicate`.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`lessThanFiveEvents()` An array of less than five events that should exist in the database.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`lessThanTwentyEvents()` An array of less than twenty events that should exist in the database.
`static <A> List<A>`	`mapEvents(Function<es.uvigo.esei.dgss.letta.domain.entities.Event,A> f)` Transforms the `events()` array with a given `Function`, returning the resulting values in a `List`.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`newEvent()` Returns an `Event` that should not exist in the database and that may be used to create a new event.
`static es.uvigo.esei.dgss.letta.domain.entities.Event`	`newEventWithoutCreator()` Returns an `Event` that should not exist in the database and that may be used to create a new event.
`static String`	`nonExistentDescription()` Returns an `Event` description that should not exist in the database.
`static int`	`nonExistentEventId()` Returns an `Event` ID that should not exist in the database.
`static String`	`nonExistentTitle()` Returns an `Event` title that should not exist in the database.
`static es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`sortedEvents(Comparator<es.uvigo.esei.dgss.letta.domain.entities.Event> cmp)` Returns the `events()` array sorted with a given `Comparator`.
`static <C extends Comparable<C>> es.uvigo.esei.dgss.letta.domain.entities.Event[]`	`sortedEvents(Function<es.uvigo.esei.dgss.letta.domain.entities.Event,C> f)` Returns the `events()` array sorted by a given transformation from `Event` to `Comparable`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - events
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] events()
```
    An array of twenty-five events that should exist in the database. This data is replicated in the events.xml file.
    
    Returns:
    
    An array of twenty-five events.
  - eventsAsList
```
public static List<es.uvigo.esei.dgss.letta.domain.entities.Event> eventsAsList()
```
  - filterEvents
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] filterEvents(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)
```
    Returns the events() that satisfy a given Predicate.
    
    Parameters:
    
    f - The predicate that every resulting Event must satisfy.
    
    Returns:
    
    An array with the Events that satisfy the given predicate.
  - eventsWithTitleOrDescriptionContaining
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] eventsWithTitleOrDescriptionContaining(String pattern)
```
    An array of Event that have in them title or description a pattern provided
    
    Parameters:
    
    pattern - String pattern used to search
    
    Returns:
    
    An array of Event containing the pattern on the title or description
  - mapEvents
```
public static <A> List<A> mapEvents(Function<es.uvigo.esei.dgss.letta.domain.entities.Event,A> f)
```
    Transforms the events() array with a given Function, returning the resulting values in a List.
    
    Type Parameters:
    
    A - The type of the resulting mapping function.
    
    Parameters:
    
    f - The mapper Function from Event to any type.
    
    Returns:
    
    A List with the results of applying the given function to all the events().
  - findEvent
```
public static Optional<es.uvigo.esei.dgss.letta.domain.entities.Event> findEvent(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)
```
    Returns an Optional holding or not the first found Event in events() that satisfies a given Predicate.
    
    Parameters:
    
    f - The predicate that the resulting Event must satisfy.
    
    Returns:
    
    An optional event that satisfies the given predicate.
  - findEventOrThrow
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event findEventOrThrow(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)
```
    Returns the first Event from events() that satisfies the given Predicate.
    
    Parameters:
    
    f - The predicate that the resulting Event must satisfy.
    
    Returns:
    
    An Event that satisfies the given predicate.
    
    Throws:
    
    IllegalArgumentException - if no Event satisfies the predicate.
  - sortedEvents
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] sortedEvents(Comparator<es.uvigo.esei.dgss.letta.domain.entities.Event> cmp)
```
    Returns the events() array sorted with a given Comparator.
    
    Parameters:
    
    cmp - The Comparator to sort the Events.
    
    Returns:
    
    An array with events sorted with the given comparator.
  - sortedEvents
```
public static <C extends Comparable<C>> es.uvigo.esei.dgss.letta.domain.entities.Event[] sortedEvents(Function<es.uvigo.esei.dgss.letta.domain.entities.Event,C> f)
```
    Returns the events() array sorted by a given transformation from Event to Comparable.
    
    Type Parameters:
    
    C - The type of the Comparable by which an Event should be compared.
    
    Parameters:
    
    f - The function mapping an Event to a Comparable instance.
    
    Returns:
    
    An array with the evens sorted by the given comparable.
  - eventWithTitle
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event eventWithTitle(String title)
```
    Returns an Event from the events() array that has the provided title.
    
    Parameters:
    
    title - The title of the Event to be returned.
    
    Returns:
    
    An Event with the provided login.
    
    Throws:
    
    IllegalArgumentException - if there is no event with the provided title.
  - eventWithType
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event eventWithType(es.uvigo.esei.dgss.letta.domain.entities.EventType type)
```
    Returns an Event from the events() array that has the provided type.
    
    Parameters:
    
    type - The EventType of the Event to be returned.
    
    Returns:
    
    An Event with the provided type.
    
    Throws:
    
    IllegalArgumentException - if there is no event with the provided type.
  - eventWithId
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event eventWithId(int id)
```
    Returns the unique Event from the events() array that has the provided ID.
    
    Parameters:
    
    id - The id of the Event to be returned, as an integer.
    
    Returns:
    
    The unique Event with the provided ID.
    
    Throws:
    
    IllegalArgumentException - if there is no event with the provided ID.
  - lessThanFiveEvents
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] lessThanFiveEvents()
```
    An array of less than five events that should exist in the database. This data is replicated in the events-less-than-five.xml file.
    
    Returns:
    
    An array of less than five events.
  - lessThanTwentyEvents
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] lessThanTwentyEvents()
```
    An array of less than twenty events that should exist in the database. This data is replicated in the events-less-than-twenty.xml file.
    
    Returns:
    
    An array of less than twenty events.
  - existentEvent
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event existentEvent()
```
    Returns an Event that should exist in the database.
    
    Returns:
    
    An Event that should exist in the database.
  - existentEventId
```
public static int existentEventId()
```
    Returns the ID of a Event that should exist in the database. This is the id of the event returned by existentEvent().
    
    Returns:
    
    The id of a event that should exist in the database.
  - nonExistentEventId
```
public static int nonExistentEventId()
```
    Returns an Event ID that should not exist in the database.
    
    Returns:
    
    an event ID that should not exist in the database.
  - nonExistentTitle
```
public static String nonExistentTitle()
```
    Returns an Event title that should not exist in the database.
    
    Returns:
    
    an event title that should not exist in the database.
  - nonExistentDescription
```
public static String nonExistentDescription()
```
    Returns an Event description that should not exist in the database.
    
    Returns:
    
    an event description that should not exist in the database.
  - newEvent
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event newEvent()
```
    Returns an Event that should not exist in the database and that may be used to create a new event. This includes a User as creator, retrieved from UsersDataset.existentUser().
    
    Returns:
    
    An event that should not exist in the database.
  - newEventWithoutCreator
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event newEventWithoutCreator()
```
    Returns an Event that should not exist in the database and that may be used to create a new event. This does not include a creator, if that is required, consider using newEvent() instead.
    
    Returns:
    
    An event that should not exist in the database, with it's creator not set.
  - eventsWithTwoJoinedUsers
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] eventsWithTwoJoinedUsers()
```
    An array of twenty-five events that should exist in the database, and with already joined users (two per event) to each event. This data is replicated in the users-joins-event.xml file.
    
    Returns:
    
    An array of twenty-five events with two users joined to each one.
  - filterEventsWithTwoJoinedUsers
```
public static es.uvigo.esei.dgss.letta.domain.entities.Event[] filterEventsWithTwoJoinedUsers(Predicate<es.uvigo.esei.dgss.letta.domain.entities.Event> f)
```
    Returns the eventsWithTwoJoinedUsers() that satisfy a given Predicate.
    
    Parameters:
    
    f - The predicate that every resulting Event must satisfy.
    
    Returns:
    
    An array with the Events that satisfy the given predicate.

Class EventsDataset

Method Summary

Methods inherited from class java.lang.Object

Method Detail

events

eventsAsList

filterEvents

eventsWithTitleOrDescriptionContaining

mapEvents

findEvent

findEventOrThrow

sortedEvents

sortedEvents

eventWithTitle

eventWithType

eventWithId

lessThanFiveEvents

lessThanTwentyEvents

existentEvent

existentEventId

nonExistentEventId

nonExistentTitle

nonExistentDescription

newEvent

newEventWithoutCreator

eventsWithTwoJoinedUsers

filterEventsWithTwoJoinedUsers