DescriptiveMetadataFacet (gCube Resources 5.2.0-SNAPSHOT API)

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:

DescriptiveMetadataFacetImpl
```
@TypeMetadata(name="DescriptiveMetadataFacet",
              description="DescriptiveMetadataFacet captures information on descriptive metadata to be associated with the resource. This facet is mainly used to attach metadata to a Dataset.",
              version="1.1.0")
@Change(version="1.1.0",description="Replaced complex ValueSchema property for \'descriptiveMetadata\' with a clean, flat String representation.") @Change(version="1.0.0",description="First Version")
public interface DescriptiveMetadataFacet
extends org.gcube.informationsystem.model.reference.entities.Facet
```
DescriptiveMetadataFacet captures information on descriptive metadata to be associated with the resource. This facet is mainly used to attach metadata to a Dataset.

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields
Modifier and Type Field Description

static String NAME
The name associated with this facet

static String VERSION
The version associated with this facet
- Fields inherited from interface org.gcube.informationsystem.base.reference.Element
  DATETIME_PATTERN, REDACTED, TYPE_PROPERTY, UNKNOWN_USER
- 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

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`static DescriptiveMetadataFacet`	`getDefaultInstance()`	Returns a default instance of DescriptiveMetadataFacet
`String`	`getDescriptiveMetadata()`	A metadata record representing the descriptive metadata.
`void`	`setDescriptiveMetadata(String metadata)`	Sets a metadata record representing the descriptive metadata.

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
```
    The name associated with this facet
    
    See Also:
    
    Constant Field Values
  - VERSION
```
static final String VERSION
```
    The version associated with this facet
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDefaultInstance
```
static DescriptiveMetadataFacet getDefaultInstance()
```
    Returns a default instance of DescriptiveMetadataFacet
    
    Returns:
    
    a default instance of DescriptiveMetadataFacet
  - getDescriptiveMetadata
```
@ISProperty(description="A metadata record representing the descriptive metadata.",
            mandatory=true)
String getDescriptiveMetadata()
```
    A metadata record representing the descriptive metadata. Deliberately unconstrained: accepts any JSON-compatible value (string, number, object, array, ...) since the concrete metadata standard in use (e.g., Dublin Core, DataCite) is not known in advance. The Java API always exposes it as a String.
    
    Returns:
    
    the metadata
  - setDescriptiveMetadata
```
void setDescriptiveMetadata(String metadata)
```
    Sets a metadata record representing the descriptive metadata.
    
    Parameters:
    
    metadata - the metadata