Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> embl >> ebi >> escience >> [ scufl overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.embl.ebi.escience.scufl
Class SemanticMarkup  

java.lang.Object
  org.embl.ebi.escience.scufl.SemanticMarkup

---

public class SemanticMarkup

extends java.lang.Object

A container class for the semantic markup and mime type data for overall workflow input and output ports, although presumably it could be attached to other entities as well. The data contained are a free text description, an array of zero or more mime types and a chunk of text containing semantic metadata. Currently this last is unstructured, but this class will be improved by the addition of a more structured version based possibly on Jena at some point.

---

Field Summary
private  java.lang.String	description
private  java.util.List	mimeTypeList
private  java.lang.String	semanticType
private  java.lang.Object	subject

 

Constructor Summary

SemanticMarkup(java.lang.Object subject)           Create a new item of semantic markup for the Object specified.

 

Method Summary
void	addMIMEType(java.lang.String mimeType)           Add a MIME type
void	clearMIMETypes()           Clear the array of MIME types
void	configureFromElement(org.jdom.Element theElement)           Configure this markup object from the supplied XML element.
(package private)  void	fireModelEvent()           If the subject of this metadata is a port then fire events off when things are changed, if not then tough, we don't know how to.
org.jdom.Element	getConfigurationElement()           Emit an element that would be used to configure this object in the method above
java.lang.String	getDescription()           Get the free text description
java.lang.String	getDisplayTypeList()           Get the MIME types as a single string with new lines seperating the types
java.lang.String	getFirstMIMEType()           Get the first MIME type in the list, or return the empty string if no MIME types have been defined.
java.util.List	getMIMETypeList()           Get hold of the List used to hold the MIME types, useful for UI components.
java.lang.String[]	getMIMETypes()           Get the array of strings containing MIME types for the item this markup object applies to.
java.lang.String	getSemanticType()           Get the string of semantic markup text FIXME - this is currently unstructured free text, which it almost certainly shouldn't be.
java.lang.Object	getSubject()           Get the Object that is the subject of this markup, if that's not too confusing a way of expressing it...
void	setDescription(java.lang.String theDescription)           Set the free text description
void	setSemanticType(java.lang.String newSemanticType)           Set the semantic markup as a string, not the best way to do things but will have to do for now

 

Methods inherited from class java.lang.Object

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

 

Field Detail

description

private java.lang.String description

---

semanticType

private java.lang.String semanticType

---

mimeTypeList

private java.util.List mimeTypeList

---

subject

private java.lang.Object subject

Constructor Detail

SemanticMarkup

public SemanticMarkup(java.lang.Object subject)

Create a new item of semantic markup for the Object specified. This should be interpreted as 'this markup object applies to the supplied Object'.

Method Detail

getMIMETypeList

public java.util.List getMIMETypeList()

Get hold of the List used to hold the MIME types, useful for UI components.

---

setDescription

public void setDescription(java.lang.String theDescription)

Set the free text description

---

getDescription

public java.lang.String getDescription()

Get the free text description

---

getSubject

public java.lang.Object getSubject()

Get the Object that is the subject of this markup, if that's not too confusing a way of expressing it... This cannot be altered once the object is created, I'm not entirely sure this is actually a requirement but I can't think of a good reason to do otherwise.

---

getMIMETypes

public java.lang.String[] getMIMETypes()

Get the array of strings containing MIME types for the item this markup object applies to.

---

getFirstMIMEType

public java.lang.String getFirstMIMEType()

Get the first MIME type in the list, or return the empty string if no MIME types have been defined.

---

getDisplayTypeList

public java.lang.String getDisplayTypeList()

Get the MIME types as a single string with new lines seperating the types

---

clearMIMETypes

public void clearMIMETypes()

Clear the array of MIME types

---

addMIMEType

public void addMIMEType(java.lang.String mimeType)

Add a MIME type

---

getSemanticType

public java.lang.String getSemanticType()

Get the string of semantic markup text FIXME - this is currently unstructured free text, which it almost certainly shouldn't be.

---

setSemanticType

public void setSemanticType(java.lang.String newSemanticType)

Set the semantic markup as a string, not the best way to do things but will have to do for now

---

configureFromElement

public void configureFromElement(org.jdom.Element theElement)

Configure this markup object from the supplied XML element. This is assuming that the element passed in is the 'metadata' element in the XScufl namespace.

---

getConfigurationElement

public org.jdom.Element getConfigurationElement()

Emit an element that would be used to configure this object in the method above

---

fireModelEvent

void fireModelEvent()

If the subject of this metadata is a port then fire events off when things are changed, if not then tough, we don't know how to.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> embl >> ebi >> escience >> [ scufl overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---