Package org.graylog.plugins.views.search.views

Class ViewDTO

java.lang.Object

org.graylog.plugins.views.search.views.ViewDTO

All Implemented Interfaces:

ViewLike, ContentPackable<ViewEntity.Builder>, MongoEntity

public abstract class ViewDTO
extends Object
implements ContentPackable<ViewEntity.Builder>, ViewLike, MongoEntity

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ViewDTO.Builder
static enum	ViewDTO.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLECTION_NAME
static final String	FIELD_CREATED_AT
static final String	FIELD_DESCRIPTION
static final String	FIELD_FAVORITE
static final String	FIELD_ID
static final String	FIELD_LAST_UPDATED_AT
static final String	FIELD_OWNER
static final String	FIELD_PROPERTIES
static final String	FIELD_REQUIRES
static final String	FIELD_SEARCH_ID
static final String	FIELD_STATE
static final String	FIELD_SUMMARY
static final String	FIELD_TITLE
static final String	FIELD_TYPE
static final String	SECONDARY_SORT
static final com.google.common.collect.ImmutableSet<String>	SORT_FIELDS
static final com.google.common.collect.ImmutableSet<String>	STRING_SORT_FIELDS

Constructor Summary

Constructors

Constructor	Description
ViewDTO()

Method Summary

Modifier and Type	Method	Description
static ViewDTO.Builder	builder()
abstract org.joda.time.DateTime	createdAt()
abstract String	description()
abstract boolean	favorite()
Optional<ViewStateDTO>	findQueryContainingWidgetId(String widgetId)
Optional<WidgetDTO>	findWidgetById(String widgetId)
Set<WidgetDTO>	getAllWidgets()
abstract String	id()	ID of the entity.
abstract org.joda.time.DateTime	lastUpdatedAt()
abstract Optional<String>	owner()
abstract com.google.common.collect.ImmutableSet<String>	properties()
Optional<String>	queryIdOfWidget(String widgetId)
abstract Map<String,PluginMetadataSummary>	requires()
void	resolveNativeEntity(EntityDescriptor entityDescriptor, com.google.common.graph.MutableGraph<EntityDescriptor> mutableGraph)
abstract String	searchId()
abstract Map<String,ViewStateDTO>	state()
abstract String	summary()
abstract @NotBlank String	title()
abstract ViewDTO.Builder	toBuilder()
ViewEntity.Builder	toContentPackEntity(EntityDescriptorIds entityDescriptorIds)
abstract ViewDTO.Type	type()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graylog2.contentpacks.ContentPackable

getContentPackPluginPackage

Field Details

COLLECTION_NAME

public static final String COLLECTION_NAME

See Also:

• Constant Field Values

FIELD_ID

public static final String FIELD_ID

See Also:

• Constant Field Values

FIELD_TYPE

public static final String FIELD_TYPE

See Also:

• Constant Field Values

FIELD_TITLE

public static final String FIELD_TITLE

See Also:

• Constant Field Values

FIELD_SUMMARY

public static final String FIELD_SUMMARY

See Also:

• Constant Field Values

FIELD_DESCRIPTION

public static final String FIELD_DESCRIPTION

See Also:

• Constant Field Values

FIELD_SEARCH_ID

public static final String FIELD_SEARCH_ID

See Also:

• Constant Field Values

FIELD_PROPERTIES

public static final String FIELD_PROPERTIES

See Also:

• Constant Field Values

FIELD_REQUIRES

public static final String FIELD_REQUIRES

See Also:

• Constant Field Values

FIELD_STATE

public static final String FIELD_STATE

See Also:

• Constant Field Values

FIELD_CREATED_AT

public static final String FIELD_CREATED_AT

See Also:

• Constant Field Values

FIELD_LAST_UPDATED_AT

public static final String FIELD_LAST_UPDATED_AT

See Also:

• Constant Field Values

FIELD_OWNER

public static final String FIELD_OWNER

See Also:

• Constant Field Values

FIELD_FAVORITE

public static final String FIELD_FAVORITE

See Also:

• Constant Field Values

SORT_FIELDS

public static final com.google.common.collect.ImmutableSet<String> SORT_FIELDS

STRING_SORT_FIELDS

public static final com.google.common.collect.ImmutableSet<String> STRING_SORT_FIELDS

SECONDARY_SORT

public static final String SECONDARY_SORT

See Also:

• Constant Field Values

Constructor Details

ViewDTO

public ViewDTO()

Method Details

id

@Nullable
public abstract String id()

Description copied from interface: MongoEntity

ID of the entity. Will be stored as field "_id" with type ObjectId in MongoDB.

Specified by:

id in interface MongoEntity

Specified by:

id in interface ViewLike

Returns:

Hex string representation of the entity's ID

type

public abstract ViewDTO.Type type()

Specified by:

type in interface ViewLike

title

@NotBlank
public abstract @NotBlank String title()

summary

public abstract String summary()

description

public abstract String description()

searchId

public abstract String searchId()

properties

public abstract com.google.common.collect.ImmutableSet<String> properties()

requires

public abstract Map<String,PluginMetadataSummary> requires()

state

public abstract Map<String,ViewStateDTO> state()

owner

public abstract Optional<String> owner()

createdAt

public abstract org.joda.time.DateTime createdAt()

lastUpdatedAt

public abstract org.joda.time.DateTime lastUpdatedAt()

favorite

public abstract boolean favorite()

builder

public static ViewDTO.Builder builder()

toBuilder

public abstract ViewDTO.Builder toBuilder()

findQueryContainingWidgetId

public Optional<ViewStateDTO> findQueryContainingWidgetId(String widgetId)

findWidgetById

public Optional<WidgetDTO> findWidgetById(String widgetId)

getAllWidgets

public Set<WidgetDTO> getAllWidgets()

queryIdOfWidget

public Optional<String> queryIdOfWidget(String widgetId)

toContentPackEntity

public ViewEntity.Builder toContentPackEntity(EntityDescriptorIds entityDescriptorIds)

Specified by:

toContentPackEntity in interface ContentPackable<ViewEntity.Builder>

resolveNativeEntity

public void resolveNativeEntity(EntityDescriptor entityDescriptor,
 com.google.common.graph.MutableGraph<EntityDescriptor> mutableGraph)

Specified by:

resolveNativeEntity in interface ContentPackable<ViewEntity.Builder>