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

Interface SoftwareFacet

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, Named, org.gcube.informationsystem.base.reference.SchemaMixedElement, Serializable

All Known Implementing Classes:

SoftwareFacetImpl

@TypeMetadata(name="SoftwareFacet",
              description="SoftwareFacet captures information on any software associated with the resource.",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface SoftwareFacet
extends org.gcube.informationsystem.model.reference.entities.Facet, Named

SoftwareFacet captures information on any software associated with the resource. https://wiki.gcube-system.org/gcube/GCube_Model#Software_Facet

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCRIPTION_PROPERTY	The name of 'description' property
static final String	GROUP_PROPERTY	The name of 'group' property
static final String	NAME	The name associated with this facet
static final String	OPTIONAL_PROPERTY	The name of 'optional' property
static final String	QUALIFIER_PROPERTY	The name of 'qualifier' property
static final String	VERSION_PROPERTY	The name of 'version' 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

Fields inherited from interface org.gcube.resourcemanagement.model.reference.properties.utilities.Named

NAME_PROPERTY

Method Summary

Modifier and Type	Method	Description
static SoftwareFacet	getDefaultInstance()	Returns a default instance of SoftwareFacet
String	getDescription()	A human oriented description of the software artifact being described
String	getGroup()	The name of 'group' the software artifact belongs to, e.g., groupId in maven coordinates, company name for retail software software such as 'Microsoft™' (in Microsoft™ Office 2013-SP2)
String	getName()	The name of the software artifact being described, e.g., artifactId in maven coordinates, the software name for retail software such as 'Office' (in Microsoft™ Office 2013-SP2)
String	getQualifier()	A qualifier for the software, e.g., packaging or scope in maven coordinates, target architecture for retail software such as x86 or amd64
String	getVersion()	The particular release of the software artifact, e.g., version in maven coordinates, the software version for retail software such as '2013-SP2' (in Microsoft™ Office 2013-SP2)
boolean	isOptional()	Used to indicate the software optionality, e.g., optional in maven coordinates
void	setDescription(String description)	Sets a human oriented description of the software artifact being described
void	setGroup(String group)	Sets the name of 'group' the software artifact belongs to, e.g., groupId in maven coordinates, company name for retail software software such as 'Microsoft™' (in Microsoft™ Office 2013-SP2)
void	setName(String name)	Sets the name of the software artifact being described, e.g., artifactId in maven coordinates, the software name for retail software such as 'Office' (in Microsoft™ Office 2013-SP2)
void	setOptional(boolean optional)	Sets the software optionality, e.g., optional in maven coordinates
void	setQualifier(String qualifier)	Sets a qualifier for the software, e.g., packaging or scope in maven coordinates, target architecture for retail software such as x86 or amd64
void	setVersion(String version)	Sets the particular release of the software artifact, e.g., version in maven coordinates, the software version for retail software such as '2013-SP2' (in Microsoft™ Office 2013-SP2)

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 Details

NAME

static final String NAME

The name associated with this facet

See Also:

• Constant Field Values

GROUP_PROPERTY

static final String GROUP_PROPERTY

The name of 'group' property

See Also:

• Constant Field Values

VERSION_PROPERTY

static final String VERSION_PROPERTY

The name of 'version' property

See Also:

• Constant Field Values

DESCRIPTION_PROPERTY

static final String DESCRIPTION_PROPERTY

The name of 'description' property

See Also:

• Constant Field Values

QUALIFIER_PROPERTY

static final String QUALIFIER_PROPERTY

The name of 'qualifier' property

See Also:

• Constant Field Values

OPTIONAL_PROPERTY

static final String OPTIONAL_PROPERTY

The name of 'optional' property

See Also:

• Constant Field Values

Method Details

getDefaultInstance

static SoftwareFacet getDefaultInstance()

Returns a default instance of SoftwareFacet

Returns:

a default instance of SoftwareFacet

getName

@ISProperty(name="name",
            description="The name of the software artifact being described, e.g., artifactId in maven coordinates, the software name for retail software such as \'Office\' (in Microsoft\u2122 Office 2013-SP2)",
            mandatory=true,
            nullable=false)
String getName()

The name of the software artifact being described, e.g., artifactId in maven coordinates, the software name for retail software such as 'Office' (in Microsoft™ Office 2013-SP2)

Specified by:

getName in interface Named

Returns:

the name

setName

void setName(String name)

Sets the name of the software artifact being described, e.g., artifactId in maven coordinates, the software name for retail software such as 'Office' (in Microsoft™ Office 2013-SP2)

Specified by:

setName in interface Named

Parameters:

name - the name

getGroup

@ISProperty(name="group",
            description="The name of \'group\' the software artifact belongs to, e.g., groupId in maven coordinates, company name for retail software software such as \'Microsoft\u2122\' (in Microsoft\u2122 Office 2013-SP2)",
            mandatory=true,
            nullable=false)
String getGroup()

The name of 'group' the software artifact belongs to, e.g., groupId in maven coordinates, company name for retail software software such as 'Microsoft™' (in Microsoft™ Office 2013-SP2)

Returns:

the group

setGroup

void setGroup(String group)

Sets the name of 'group' the software artifact belongs to, e.g., groupId in maven coordinates, company name for retail software software such as 'Microsoft™' (in Microsoft™ Office 2013-SP2)

Parameters:

group - the group

getVersion

@ISProperty(name="version",
            description="The particular release of the software artifact, e.g., version in maven coordinates, the software version for retail software such as \'2013-SP2\' (in Microsoft\u2122 Office 2013-SP2)",
            mandatory=true,
            nullable=false)
String getVersion()

The particular release of the software artifact, e.g., version in maven coordinates, the software version for retail software such as '2013-SP2' (in Microsoft™ Office 2013-SP2)

Returns:

the version

setVersion

void setVersion(String version)

Sets the particular release of the software artifact, e.g., version in maven coordinates, the software version for retail software such as '2013-SP2' (in Microsoft™ Office 2013-SP2)

Parameters:

version - the version

getDescription

@ISProperty(name="description",
            description="A human oriented description of the software artifact being described")
String getDescription()

A human oriented description of the software artifact being described

Returns:

the description

setDescription

void setDescription(String description)

Sets a human oriented description of the software artifact being described

Parameters:

description - the description

getQualifier

@ISProperty(name="qualifier",
            description="A qualifier for the software, e.g., packaging or scope in maven coordinates, target architecture for retail software such as x86 or amd64")
String getQualifier()

A qualifier for the software, e.g., packaging or scope in maven coordinates, target architecture for retail software such as x86 or amd64

Returns:

the qualifier

setQualifier

void setQualifier(String qualifier)

Sets a qualifier for the software, e.g., packaging or scope in maven coordinates, target architecture for retail software such as x86 or amd64

Parameters:

qualifier - the qualifier

isOptional

@ISProperty(name="optional",
            description="Used to indicate the software optionality, e.g., optional in maven coordinates")
boolean isOptional()

Used to indicate the software optionality, e.g., optional in maven coordinates

Returns:

true if the software is optional

setOptional

void setOptional(boolean optional)

Sets the software optionality, e.g., optional in maven coordinates

Parameters:

optional - true if the software is optional