Package org.eclipse.lyo.oslc4j.core.model

Class ResourceShape

java.lang.Object

org.eclipse.lyo.oslc4j.core.model.AbstractResource

org.eclipse.lyo.oslc4j.core.model.ResourceShape

All Implemented Interfaces:

IExtendedResource, IResource

@OslcNamespace("http://open-services.net/ns/core#")
@OslcResourceShape(title="OSLC Resource Shape Resource Shape",
                   describes="http://open-services.net/ns/core#ResourceShape")
public final class ResourceShape
extends AbstractResource

OSLC ResourceShape resource

Constructor Summary

Constructors

Constructor	Description
ResourceShape()
ResourceShape(URI about)

Method Summary

Modifier and Type	Method	Description
void	addDescribeItem(URI describeItem)
void	addProperty(Property property)
URI[]	getDescribes()	Type or types of resource described by this shape
String	getDescription()	The description of the defined constraint.
String	getName()	The local name of the defined resource
Property[]	getProperties()	The properties that are allowed or required by this shape
Property	getProperty(URI definition)
String	getTitle()	Title of the resource shape.
void	setDescribes(URI[] describes)
void	setDescription(String description)
void	setName(String name)
void	setProperties(Property[] properties)
void	setTitle(String title)

Methods inherited from class org.eclipse.lyo.oslc4j.core.model.AbstractResource

addType, getAbout, getExtendedProperties, getTypes, setAbout, setExtendedProperties, setTypes

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceShape

public ResourceShape()

ResourceShape

public ResourceShape(URI about)

Method Details

addDescribeItem

public void addDescribeItem(URI describeItem)

addProperty

public void addProperty(Property property)

getProperty

public Property getProperty(URI definition)

getDescribes

@OslcDescription("Type or types of resource described by this shape")
@OslcPropertyDefinition("http://open-services.net/ns/core#describes")
@OslcReadOnly
@OslcTitle("Describes")
public URI[] getDescribes()

Type or types of resource described by this shape

Returns:

describes

getProperties

@OslcDescription("The properties that are allowed or required by this shape")
@OslcName("property")
@OslcPropertyDefinition("http://open-services.net/ns/core#property")
@OslcRange("http://open-services.net/ns/core#Property")
@OslcReadOnly
@OslcRepresentation(Inline)
@OslcTitle("Properties")
@OslcValueShape("resourceShapes/property")
@OslcValueType(LocalResource)
public Property[] getProperties()

The properties that are allowed or required by this shape

Returns:

properties

getName

@OslcDescription("The local name of the defined resource")
@OslcOccurs(ExactlyOne)
@OslcPropertyDefinition("http://open-services.net/ns/core#name")
@OslcReadOnly
@OslcTitle("Name")
public String getName()

The local name of the defined resource

Returns:

name

getTitle

@OslcDescription("Title of the resource shape. SHOULD include only content that is valid and suitable inside an XHTML <div> element")
@OslcPropertyDefinition("http://purl.org/dc/terms/title")
@OslcReadOnly
@OslcTitle("Title")
@OslcValueType(XMLLiteral)
public String getTitle()

Title of the resource shape. SHOULD include only content that is valid and suitable inside an XHTML <div> element

Returns:

title

getDescription

@OslcDescription("The description of the defined constraint.")
@OslcPropertyDefinition("http://purl.org/dc/terms/description")
@OslcReadOnly
@OslcTitle("Description")
@OslcValueType(XMLLiteral)
public String getDescription()

The description of the defined constraint.

Returns:

description

setDescribes

public void setDescribes(URI[] describes)

setProperties

public void setProperties(Property[] properties)

setName

public void setName(String name)

setTitle

public void setTitle(String title)

setDescription

public void setDescription(String description)