org.graylog2.contentpacks.facades

Class LookupTableFacade

java.lang.Object

org.graylog2.contentpacks.facades.LookupTableFacade

All Implemented Interfaces:

EntityFacade<LookupTableDto>, EntityWithExcerptFacade<LookupTableDto,LookupTableDto>

public class LookupTableFacade
extends Object
implements EntityFacade<LookupTableDto>

Field Summary

Fields

Modifier and Type	Field and Description
static ModelType	TYPE_V1

Constructor Summary

Constructors

Constructor and Description
LookupTableFacade(com.fasterxml.jackson.databind.ObjectMapper objectMapper, DBLookupTableService lookupTableService)

Method Summary

Modifier and Type	Method and Description
EntityExcerpt	createExcerpt(LookupTableDto lookupTableDto) Create an excerpt (id, type, title) of a native entity for display purposes.
NativeEntity<LookupTableDto>	createNativeEntity(Entity entity, Map<String,ValueReference> parameters, Map<EntityDescriptor,Object> nativeEntities, String username) Create a native entity of type T from an entity model.
void	delete(LookupTableDto nativeEntity) Delete the given native entity.
Optional<Entity>	exportEntity(EntityDescriptor entityDescriptor, EntityDescriptorIds entityDescriptorIds) Create an exportable model of a native entity referenced by an EntityDescriptor including optional constraints.
Optional<NativeEntity<LookupTableDto>>	findExisting(Entity entity, Map<String,ValueReference> parameters) Find an existing instance of the native entity described by the entity model.
Set<EntityExcerpt>	listEntityExcerpts() Create entity excerpts of all native entities of type T.
Optional<NativeEntity<LookupTableDto>>	loadNativeEntity(NativeEntityDescriptor nativeEntityDescriptor) Loads the native entity instance for the given native entity descriptor.
com.google.common.graph.Graph<Entity>	resolveForInstallation(Entity entity, Map<String,ValueReference> parameters, Map<EntityDescriptor,Entity> entities) Create the dependency graph of an entity described by the given entity model during content pack installation.
com.google.common.graph.Graph<EntityDescriptor>	resolveNativeEntity(EntityDescriptor entityDescriptor) Create the dependency graph of a native entity described by the given entity descriptor.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_V1

public static final ModelType TYPE_V1

Constructor Detail

LookupTableFacade

@Inject
public LookupTableFacade(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                 DBLookupTableService lookupTableService)

Method Detail

createNativeEntity

public NativeEntity<LookupTableDto> createNativeEntity(Entity entity,
                                                       Map<String,ValueReference> parameters,
                                                       Map<EntityDescriptor,Object> nativeEntities,
                                                       String username)

Description copied from interface: EntityWithExcerptFacade

Create a native entity of type T from an entity model.

Specified by:

createNativeEntity in interface EntityWithExcerptFacade<LookupTableDto,LookupTableDto>

Parameters:

entity - the entity model from which a native entity should be created

parameters - user-provided parameters to resolve parameters in the entity model

nativeEntities - existing native entities to reference during the creation of the native entity

username - the name of the user creating the entity

Returns:

the created native entity wrapped in

See Also:

Entity, NativeEntity

findExisting

public Optional<NativeEntity<LookupTableDto>> findExisting(Entity entity,
                                                           Map<String,ValueReference> parameters)

Description copied from interface: EntityWithExcerptFacade

Find an existing instance of the native entity described by the entity model.

Specified by:

findExisting in interface EntityWithExcerptFacade<LookupTableDto,LookupTableDto>

Parameters:

entity - the entity model from which a native entity should be created

parameters - user-provided parameters to resolve parameters in the entity model

Returns:

the existing native entity in the database wrapped in NativeEntity, or Optional.empty() if the entity couldn't be found.

See Also:

Entity, NativeEntity

loadNativeEntity

public Optional<NativeEntity<LookupTableDto>> loadNativeEntity(NativeEntityDescriptor nativeEntityDescriptor)

Description copied from interface: EntityWithExcerptFacade

Loads the native entity instance for the given native entity descriptor.

Specified by:

loadNativeEntity in interface EntityWithExcerptFacade<LookupTableDto,LookupTableDto>

Parameters:

nativeEntityDescriptor - the native entity descriptor

Returns:

the existing native entity in the database wrapped in NativeEntity, or Optional.empty() if the native entity doesn't exist.

delete

public void delete(LookupTableDto nativeEntity)

Description copied from interface: EntityWithExcerptFacade

Delete the given native entity.

Specified by:

delete in interface EntityWithExcerptFacade<LookupTableDto,LookupTableDto>

Parameters:

nativeEntity - The native entity to delete

createExcerpt

public EntityExcerpt createExcerpt(LookupTableDto lookupTableDto)

Description copied from interface: EntityWithExcerptFacade

Create an excerpt (id, type, title) of a native entity for display purposes.

Specified by:

createExcerpt in interface EntityWithExcerptFacade<LookupTableDto,LookupTableDto>

Parameters:

lookupTableDto - The native entity to create an excerpt of

Returns:

The entity excerpt of the native entity

See Also:

EntityExcerpt

listEntityExcerpts

public Set<EntityExcerpt> listEntityExcerpts()

Description copied from interface: EntityWithExcerptFacade

Create entity excerpts of all native entities of type T.

Specified by:

listEntityExcerpts in interface EntityWithExcerptFacade<LookupTableDto,LookupTableDto>

Returns:

A collection of entity excerpts of all native entities of type T

See Also:

EntityExcerpt

exportEntity

public Optional<Entity> exportEntity(EntityDescriptor entityDescriptor,
                                     EntityDescriptorIds entityDescriptorIds)

Description copied from interface: EntityWithExcerptFacade

Create an exportable model of a native entity referenced by an EntityDescriptor including optional constraints.

Specified by:

exportEntity in interface EntityWithExcerptFacade<LookupTableDto,LookupTableDto>

Parameters:

entityDescriptor - the descriptor of the native entity to export

entityDescriptorIds - the IDs for all entity descriptors

Returns:

an exportable (serializable) model of the entity including optional constraints, or Optional.empty() if the entity couldn't be found.

resolveNativeEntity

public com.google.common.graph.Graph<EntityDescriptor> resolveNativeEntity(EntityDescriptor entityDescriptor)

Description copied from interface: EntityWithExcerptFacade

Create the dependency graph of a native entity described by the given entity descriptor.

Specified by:

resolveNativeEntity in interface EntityWithExcerptFacade<LookupTableDto,LookupTableDto>

Parameters:

entityDescriptor - the descriptor of the native entity to resolve dependencies for

Returns:

A directed graph of the native entity with entity descriptors as nodes.

See Also:

Graph

resolveForInstallation

public com.google.common.graph.Graph<Entity> resolveForInstallation(Entity entity,
                                                                    Map<String,ValueReference> parameters,
                                                                    Map<EntityDescriptor,Entity> entities)

Description copied from interface: EntityWithExcerptFacade

Create the dependency graph of an entity described by the given entity model during content pack installation.

Specified by:

resolveForInstallation in interface EntityWithExcerptFacade<LookupTableDto,LookupTableDto>

Parameters:

entity - the entity model to resolve dependencies for

Returns:

A directed graph of the native entity with entity models as nodes.

See Also:

Graph