com.epimorphics.server.webapi.dsapi

Class DSStructure

java.lang.Object

com.epimorphics.server.webapi.dsapi.DSStructure

All Implemented Interfaces:

JSONWritable

public class DSStructure
extends Object
implements JSONWritable

Represents the structure of a dataset. Normally extracted from a DSD.

Author:

Dave Reynolds

Field Summary

Fields

Modifier and Type	Field and Description
protected List<DSAPIComponent>	components
protected String	description
protected com.hp.hpl.jena.rdf.model.Resource	dsd
protected String	id
protected String	label

Constructor Summary

Constructors

Constructor and Description
DSStructure(com.hp.hpl.jena.rdf.model.Resource dsd, DSAPI api) Parse a data structure definition to find the structure of a dataset.

Method Summary

Methods

Modifier and Type	Method and Description
int	getComponentIndex(String id) Return the index of a component (identified by ID) within the structure signature, or -1 if the component is not recognized
List<DSAPIComponent>	getComponents()
String	getDescription()
com.hp.hpl.jena.rdf.model.Resource	getDsd()
String	getId()
String	getLabel()
void	writeTo(JSFullWriter out)

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

dsd

protected com.hp.hpl.jena.rdf.model.Resource dsd

label

protected String label

description

protected String description

components

protected List<DSAPIComponent> components

Constructor Detail

DSStructure

public DSStructure(com.hp.hpl.jena.rdf.model.Resource dsd,
           DSAPI api)

Parse a data structure definition to find the structure of a dataset. The corresponding model must be suitably locked for reading.

Method Detail

getComponents

public List<DSAPIComponent> getComponents()

getId

public String getId()

getDsd

public com.hp.hpl.jena.rdf.model.Resource getDsd()

getLabel

public String getLabel()

getDescription

public String getDescription()

getComponentIndex

public int getComponentIndex(String id)

Return the index of a component (identified by ID) within the structure signature, or -1 if the component is not recognized

writeTo

public void writeTo(JSFullWriter out)

Specified by:

writeTo in interface JSONWritable