Package org.gcube.resourcemanagement.model.reference.entities.facets

Interface DiscoveryFacet

All Superinterfaces:

org.gcube.informationsystem.base.reference.Element, org.gcube.informationsystem.model.reference.entities.Entity, org.gcube.informationsystem.base.reference.entities.EntityElement, org.gcube.informationsystem.model.reference.ERElement, org.gcube.informationsystem.model.reference.entities.Facet, org.gcube.informationsystem.base.reference.IdentifiableElement, org.gcube.informationsystem.model.reference.ModelElement, org.gcube.informationsystem.base.reference.SchemaMixedElement, Serializable

All Known Implementing Classes:

DiscoveryFacetImpl

@TypeMetadata(name="DiscoveryFacet",
              description="This facet captures information on the discovery of resources in a group.",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface DiscoveryFacet
extends org.gcube.informationsystem.model.reference.entities.Facet

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field	Description
static String	DESCRIPTION_PROPERTY
static String	GROUP_PROPERTY
static String	MAX_PROPERTY
static String	MIN_PROPERTY
static String	NAME
static String	QUERIES_PROPERTY
static String	QUERY_TEMPLATES_PROPERTY

Fields inherited from interface org.gcube.informationsystem.base.reference.Element

DATETIME_PATTERN, TYPE_PROPERTY

Fields inherited from interface org.gcube.informationsystem.model.reference.ERElement

CONTEXTS_PROPERTY

Fields inherited from interface org.gcube.informationsystem.base.reference.IdentifiableElement

ID_PROPERTY, METADATA_PROPERTY

Fields inherited from interface org.gcube.informationsystem.model.reference.ModelElement

EXPECTED_TYPE_PROPERTY, SUPERTYPES_PROPERTY

Method Summary

Modifier and Type	Method	Description
void	addQuery(org.gcube.com.fasterxml.jackson.databind.node.ObjectNode query)
void	addQueryTemplates(QueryTemplateReference queryTemplates)
String	getDescription()
String	getGroup()
Integer	getMax()
int	getMin()
org.gcube.com.fasterxml.jackson.databind.node.ArrayNode	getQueries()
List<QueryTemplateReference>	getQueryTemplates()
void	setDescription(String description)
void	setGroup(String group)
void	setMax(Integer max)
void	setMin(int min)
void	setQueries(org.gcube.com.fasterxml.jackson.databind.node.ArrayNode queries)
void	setQueryTemplates(List<QueryTemplateReference> queryTemplates)

Methods inherited from interface org.gcube.informationsystem.base.reference.Element

getTypeName

Methods inherited from interface org.gcube.informationsystem.base.reference.entities.EntityElement

getID, getMetadata, setID, setMetadata

Methods inherited from interface org.gcube.informationsystem.model.reference.ERElement

getContexts

Methods inherited from interface org.gcube.informationsystem.model.reference.entities.Facet

getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalProperty

Methods inherited from interface org.gcube.informationsystem.model.reference.ModelElement

getExpectedtype, getSupertypes

Field Detail

NAME

static final String NAME

See Also:

Constant Field Values

GROUP_PROPERTY

static final String GROUP_PROPERTY

See Also:

Constant Field Values

DESCRIPTION_PROPERTY

static final String DESCRIPTION_PROPERTY

See Also:

Constant Field Values

MAX_PROPERTY

static final String MAX_PROPERTY

See Also:

Constant Field Values

MIN_PROPERTY

static final String MIN_PROPERTY

See Also:

Constant Field Values

QUERIES_PROPERTY

static final String QUERIES_PROPERTY

See Also:

Constant Field Values

QUERY_TEMPLATES_PROPERTY

static final String QUERY_TEMPLATES_PROPERTY

See Also:

Constant Field Values

Method Detail

getGroup

@ISProperty(name="group",
            description="The name of the \'group\' of resources to discover.",
            mandatory=true,
            nullable=false)
String getGroup()

setGroup

void setGroup(String group)

getDescription

@ISProperty(name="description",
            description="The description to display for the group of discovered resources")
String getDescription()

setDescription

void setDescription(String description)

getMin

@ISProperty(name="min",
            readonly=false,
            mandatory=true,
            nullable=false,
            defaultValue="0")
int getMin()

setMin

void setMin(int min)

getMax

@ISProperty(name="max",
            readonly=false,
            mandatory=true,
            nullable=true,
            defaultValue="null")
Integer getMax()

setMax

void setMax(Integer max)

getQueries

@ISProperty(name="queries",
            description="A list of queries to invoke to retrieve the resources",
            readonly=false,
            mandatory=true,
            nullable=true,
            defaultValue="null")
org.gcube.com.fasterxml.jackson.databind.node.ArrayNode getQueries()

setQueries

void setQueries(org.gcube.com.fasterxml.jackson.databind.node.ArrayNode queries)

addQuery

void addQuery(org.gcube.com.fasterxml.jackson.databind.node.ObjectNode query)

getQueryTemplates

@ISProperty(name="queryTemplates",
            description="A list of query templates to invoke to retrieve the resources",
            readonly=false,
            mandatory=true,
            nullable=true,
            defaultValue="null")
List<QueryTemplateReference> getQueryTemplates()

setQueryTemplates

void setQueryTemplates(List<QueryTemplateReference> queryTemplates)

addQueryTemplates

void addQueryTemplates(QueryTemplateReference queryTemplates)