information-system-model/src/main/java/org/gcube/informationsystem/model/reference/entities/Resource.java

86 lines
2.9 KiB
Java

/**
*
*/
package org.gcube.informationsystem.model.reference.entities;
import java.util.List;
import java.util.UUID;
import org.gcube.informationsystem.model.reference.relations.ConsistsOf;
import org.gcube.informationsystem.model.reference.relations.IsRelatedTo;
import org.gcube.informationsystem.types.annotations.Abstract;
import org.gcube.informationsystem.types.annotations.ResourceSchema;
import org.gcube.informationsystem.types.annotations.ResourceSchemaEntry;
import org.gcube.informationsystem.types.annotations.ResourceSchemaRelatedEntry;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
/**
* @author Luca Frosini (ISTI - CNR)
* https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Resources
*/
@Abstract
@JsonIgnoreProperties(ignoreUnknown=true)
// @JsonDeserialize(as=ResourceImpl.class) Do not uncomment to manage subclasses
@ResourceSchema(
facets={
@ResourceSchemaEntry(relation=ConsistsOf.class, facet=Facet.class, min=1, description="Any Resource consists of one or more Facets which describes the different aspects of the resource."),
},
resources= {
@ResourceSchemaRelatedEntry(source=Resource.class, relation=IsRelatedTo.class, target=Resource.class, description="Any Resource can be related to any other resource.")
}
)
public interface Resource extends Entity {
public static final String NAME = "Resource"; //Resource.class.getSimpleName();
public static final String DESCRIPTION = "This is the base class for Resources";
public static final String VERSION = "1.0.0";
public static final String CONSISTS_OF_PROPERTY = "consistsOf";
public static final String IS_RELATED_TO_PROPERTY = "isRelatedTo";
// @JsonManagedReference
public List<ConsistsOf<? extends Resource, ? extends Facet>> getConsistsOf();
@JsonIgnore
public <C extends ConsistsOf<? extends Resource, ? extends Facet>> List<C> getConsistsOf(Class<C> clz);
@JsonIgnore
public <F extends Facet, C extends ConsistsOf<? extends Resource, F>> List<C> getConsistsOf(Class<C> clz, Class<F> target);
// @JsonManagedReference
public List<IsRelatedTo<? extends Resource, ? extends Resource>> getIsRelatedTo();
@JsonIgnore
public <I extends IsRelatedTo<? extends Resource, ? extends Resource>> List<I> getIsRelatedTo(Class<I> clz);
@JsonIgnore
public List<? extends Facet> getFacets();
@JsonIgnore
public <F extends Facet> List<F> getFacets(Class<F> clz);
@JsonIgnore
public <F extends Facet, C extends ConsistsOf<? extends Resource, F>> List<F> getFacets(Class<C> clz, Class<F> target);
public void addFacet(UUID uuid);
public <F extends Facet> void addFacet(F facet);
public <C extends ConsistsOf<? extends Resource, ? extends Facet>> void addFacet(C relation);
/*
public void attachResource(UUID uuid);
public <R extends Resource> void attachResource(R resource);
*/
public <I extends IsRelatedTo<? extends Resource, ? extends Resource>> void attachResource(I relation);
}