public class VdiTool extends java.lang.Object implements RvdiCreator, RvdiParser, PvdiCreator, PvdiParser, SvdiCreator, SvdiParser
File rvdi = new File("R-VDI filePath"); PvdiCreator pubVdiTool = VdiTool.newPvdiCreator(rvdi);or using just the rvdi identifier :
PvdiCreator pubVdiTool = VdiTool.newPvdiCreator("urn:convergence:myRvdiId");
Modifier and Type | Method and Description |
---|---|
void |
addAsset(org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl.Resource resource,
java.util.List<org.iso.mpeg.mxm.tEngine.relTE.schemahandler.relr.License> licenses,
java.util.List<org.iso.mpeg.mxm.tEngine.eventreportTE.schemahandler.er.ERR> errs) |
void |
addERR(org.iso.mpeg.mxm.tEngine.eventreportTE.schemahandler.er.ERR err)
Adds an event report request associated with the VDI.
|
void |
addFieldValue(java.lang.String field,
java.lang.Object value)
Adds a field/value pair description to the VDI, e.g. genre, comedy.
|
void |
addFieldValueCondition(java.lang.String field,
java.lang.String operator,
java.lang.Object value)
This method adds a field value condition to the users subscription query.
|
void |
addKeyword(java.lang.String keyword)
Adds a keyword description to the VDI, e.g. comedy
|
void |
addKeywordCondition(java.util.List<java.lang.String> keywords)
Adds a list of keyword conditions to the users subscription query.
|
void |
addLicense(org.iso.mpeg.mxm.tEngine.relTE.schemahandler.relr.License license)
Adds a license to the VDI.
|
void |
addRelationship(java.lang.String relationshipType,
java.lang.String vdiId)
Adds a relationship descriptor stating a semantic relationship between another VDI and the VDI to be created.
|
void |
addSignature(org.iso.mpeg.mxm.tEngine.securityTE.schemahandler.dsig.Signature signature)
Adds a signature to the VDI.
|
void |
addSparqlFilterCondition(java.lang.String object,
java.lang.String operator,
java.lang.Object value)
This method enables the definition of a filter condition based on the value of a property.
|
void |
addSparqlReturnVariable(java.lang.String varName)
This method sets the variable that will be returned from the query.
|
void |
addSparqlTripleCondition(java.lang.String subject,
java.lang.String predicate,
java.lang.String object)
Adds a triple condition to the sparql query.
|
void |
addSparqlTripleLiteralCondition(java.lang.String subject,
java.lang.String predicate,
java.lang.Object object)
Adds a triple literal condition to the sparql query.
|
void |
addStructuredData(org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl_msx.StructuredData structuredData)
The method adds structured metadata descriptions to the VDI.
|
void |
addTag(java.lang.String tag)
This method adds a tag description to the VDI.
|
void |
addTagCondition(java.util.List<java.lang.String> tags)
Adds a list of tag conditions to the users subscription query.
|
boolean |
advertise(java.lang.String filePath)
Advertises the R-VDI in CoNet that is located in filePath.
|
org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl.Resource |
createResource(java.lang.String resourceURL,
java.lang.String mimtType,
java.lang.String content)
This method adds a resource reference descriptor to the R-VDI.
|
org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl.DIDL |
generatePVDI()
With this method the user may create the P-VDI.
|
org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl.DIDL |
generateRVDI()
This method allows the creation of the R-VDI, provided that metadata, licenses, etc. have been inserted.
|
org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl.DIDL |
generateSVDI()
With this method the user may create the S-VDI.
|
java.util.Date |
getExpiryDate()
Returns the expiration date of the VDI
|
java.util.Map<java.lang.String,java.util.List<java.lang.Object>> |
getFieldValueMap()
The method returns all field value descriptions in a map object.
|
java.lang.String |
getFractal()
The method returns the fractals that the VDI belongs to.
|
java.lang.String |
getIdentifier()
Returns the identifier of the VDI
|
java.util.List<java.lang.String> |
getKeywordList()
The method returns all the keywords that describe the VDI.
|
java.util.List<org.iso.mpeg.mxm.tEngine.relTE.schemahandler.relr.License> |
getLicenseList()
Returns a list containing all the licenses that are embedded in the VDI.
|
java.util.List<eu.convergence.middleware.engine.vdiTE.Relationship> |
getRelationshipList() |
java.util.Map<java.lang.String,java.lang.String> |
getRelationshipMap()
Returns a map object containing the identifiers and the relationship to them.
|
java.util.Map<java.lang.String,java.lang.String> |
getResourceMap()
Returns a map object containing resource references and their mime type
|
java.util.List<org.iso.mpeg.mxm.tEngine.securityTE.schemahandler.dsig.Signature> |
getSignatureList()
Returns a list containing all the signatures that are embedded in the VDI.
|
java.util.Date |
getStartDate()
Returns the start validity date of the VDI
|
java.util.List<org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl_msx.StructuredData> |
getStructuredDataList()
Returns a list of all the structured data descriptors of the VDI.
|
java.util.List<java.lang.String> |
getTagList()
The method returns all the tags that describe the VDI.
|
static PvdiCreator |
newPvdiCreator(java.lang.String rvdiId) |
static PvdiParser |
newPvdiParser(java.io.File pvdiFile) |
static PvdiParser |
newPvdiParser(java.lang.String pvdiId) |
static RvdiCreator |
newRvdiCreator() |
static RvdiParser |
newRvdiParser(java.lang.String rvdiId) |
static SvdiCreator |
newSvdiCreator() |
static SvdiParser |
newSvdiParser(java.io.File svdiFile) |
static SvdiParser |
newSvdiParser(java.lang.String svdiId) |
boolean |
publish()
Publishes the VDI to the CONVERGENCE cloud
|
void |
setExpiryDate(java.util.Date expiryDate)
Sets the expiration date of the VDI.
|
void |
setFractal(java.lang.String fractal)
Sets the VDI destination fractal, which is identified by a string (e.g. photo fractal).
|
void |
setResultLimit(long limit)
This method sets a limit for the returned results.
|
void |
setStartDate(java.util.Date startDate)
Sets the start date of validity of the VDI.
|
boolean |
store(java.lang.String filePath)
Stores the VDI to the specified filePath location.
|
java.lang.String |
subscribe()
Sends the S-VDI to the CONVERGENCE cloud
|
public static RvdiCreator newRvdiCreator()
public static RvdiParser newRvdiParser(java.lang.String rvdiId)
public static PvdiCreator newPvdiCreator(java.lang.String rvdiId)
public static PvdiParser newPvdiParser(java.io.File pvdiFile)
public static PvdiParser newPvdiParser(java.lang.String pvdiId)
public static SvdiCreator newSvdiCreator()
public static SvdiParser newSvdiParser(java.io.File svdiFile)
public static SvdiParser newSvdiParser(java.lang.String svdiId)
public void addLicense(org.iso.mpeg.mxm.tEngine.relTE.schemahandler.relr.License license)
PvdiCreator
addLicense
in interface PvdiCreator
addLicense
in interface SvdiCreator
license
- A REL license.public void setStartDate(java.util.Date startDate)
RvdiCreator
setStartDate
in interface PvdiCreator
setStartDate
in interface RvdiCreator
setStartDate
in interface SvdiCreator
startDate
- A date.public void setExpiryDate(java.util.Date expiryDate)
RvdiCreator
setExpiryDate
in interface PvdiCreator
setExpiryDate
in interface RvdiCreator
setExpiryDate
in interface SvdiCreator
expiryDate
- A date.public void addSignature(org.iso.mpeg.mxm.tEngine.securityTE.schemahandler.dsig.Signature signature)
RvdiCreator
addSignature
in interface PvdiCreator
addSignature
in interface RvdiCreator
addSignature
in interface SvdiCreator
signature
- A XML Signature.public java.lang.String getIdentifier()
RvdiCreator
getIdentifier
in interface PvdiParser
getIdentifier
in interface RvdiCreator
getIdentifier
in interface RvdiParser
getIdentifier
in interface SvdiParser
public java.util.List<org.iso.mpeg.mxm.tEngine.relTE.schemahandler.relr.License> getLicenseList()
RvdiParser
getLicenseList
in interface PvdiParser
getLicenseList
in interface RvdiParser
getLicenseList
in interface SvdiParser
public java.util.Map<java.lang.String,java.lang.String> getResourceMap()
RvdiParser
getResourceMap
in interface RvdiParser
public java.util.Date getStartDate()
RvdiParser
getStartDate
in interface PvdiParser
getStartDate
in interface RvdiParser
getStartDate
in interface SvdiParser
public java.util.Date getExpiryDate()
RvdiParser
getExpiryDate
in interface PvdiParser
getExpiryDate
in interface RvdiParser
getExpiryDate
in interface SvdiParser
public java.util.List<org.iso.mpeg.mxm.tEngine.securityTE.schemahandler.dsig.Signature> getSignatureList()
RvdiParser
getSignatureList
in interface PvdiParser
getSignatureList
in interface RvdiParser
getSignatureList
in interface SvdiParser
public void addFieldValueCondition(java.lang.String field, java.lang.String operator, java.lang.Object value)
SvdiCreator
addFieldValueCondition
in interface SvdiCreator
field
- A field.operator
- The comparison operator. "=", ">" or "<".value
- A value.public void addKeywordCondition(java.util.List<java.lang.String> keywords)
SvdiCreator
addKeywordCondition
in interface SvdiCreator
keywords
- A keyword list.public void addTagCondition(java.util.List<java.lang.String> tags)
SvdiCreator
addTagCondition
in interface SvdiCreator
tags
- A tag list.public void addSparqlTripleCondition(java.lang.String subject, java.lang.String predicate, java.lang.String object)
SvdiCreator
addSparqlTripleCondition
in interface SvdiCreator
subject
- The subject of the condition.predicate
- The predicate of the condition.object
- The object of the condition.public void addSparqlTripleLiteralCondition(java.lang.String subject, java.lang.String predicate, java.lang.Object object)
SvdiCreator
addSparqlTripleLiteralCondition
in interface SvdiCreator
subject
- The subject of the literal condition.predicate
- The predicate of the literal condition.object
- The object of the literal condition.public void addSparqlFilterCondition(java.lang.String object, java.lang.String operator, java.lang.Object value)
SvdiCreator
addSparqlFilterCondition
in interface SvdiCreator
object
- The variable object of a triple codition that will be used to filter the resultset.operator
- The operator of the filtering e.g. equality "=".value
- The value of the filtering.public void addSparqlReturnVariable(java.lang.String varName)
SvdiCreator
addSparqlReturnVariable
in interface SvdiCreator
varName
- The name of the variable e.g. ?x.public void setResultLimit(long limit)
SvdiCreator
setResultLimit
in interface SvdiCreator
limit
- A limit.public org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl.DIDL generateSVDI()
SvdiCreator
generateSVDI
in interface SvdiCreator
public java.lang.String subscribe()
SvdiCreator
subscribe
in interface SvdiCreator
public java.lang.String getFractal()
PvdiParser
getFractal
in interface PvdiParser
getFractal
in interface SvdiParser
public java.util.List<java.lang.String> getKeywordList()
RvdiParser
getKeywordList
in interface PvdiParser
getKeywordList
in interface RvdiParser
public java.util.List<java.lang.String> getTagList()
RvdiParser
getTagList
in interface PvdiParser
getTagList
in interface RvdiParser
public void setFractal(java.lang.String fractal)
PvdiCreator
setFractal
in interface PvdiCreator
setFractal
in interface SvdiCreator
fractal
- The fractal.public void addERR(org.iso.mpeg.mxm.tEngine.eventreportTE.schemahandler.er.ERR err)
PvdiCreator
addERR
in interface PvdiCreator
addERR
in interface SvdiCreator
err
- A event report request.public org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl.DIDL generatePVDI()
PvdiCreator
generatePVDI
in interface PvdiCreator
public boolean publish()
PvdiCreator
publish
in interface PvdiCreator
public java.util.Map<java.lang.String,java.util.List<java.lang.Object>> getFieldValueMap()
RvdiParser
getFieldValueMap
in interface PvdiParser
getFieldValueMap
in interface RvdiParser
public java.util.List<org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl_msx.StructuredData> getStructuredDataList()
RvdiParser
getStructuredDataList
in interface PvdiParser
getStructuredDataList
in interface RvdiParser
public java.util.Map<java.lang.String,java.lang.String> getRelationshipMap()
RvdiParser
getRelationshipMap
in interface RvdiParser
public java.util.List<eu.convergence.middleware.engine.vdiTE.Relationship> getRelationshipList()
public void addKeyword(java.lang.String keyword)
RvdiCreator
addKeyword
in interface PvdiCreator
addKeyword
in interface RvdiCreator
keyword
- A keyword.public void addTag(java.lang.String tag)
RvdiCreator
addTag
in interface PvdiCreator
addTag
in interface RvdiCreator
tag
- A tag.public void addFieldValue(java.lang.String field, java.lang.Object value)
RvdiCreator
addFieldValue
in interface PvdiCreator
addFieldValue
in interface RvdiCreator
field
- A field.value
- A value.public void addStructuredData(org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl_msx.StructuredData structuredData)
RvdiCreator
addStructuredData
in interface PvdiCreator
addStructuredData
in interface RvdiCreator
structuredData
- A structuredData object.public void addRelationship(java.lang.String relationshipType, java.lang.String vdiId)
RvdiCreator
addRelationship
in interface RvdiCreator
relationshipType
- The relationship type.vdiId
- The identifier of the digital item having the relationship with.public org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl.Resource createResource(java.lang.String resourceURL, java.lang.String mimtType, java.lang.String content)
RvdiCreator
createResource
in interface RvdiCreator
resourceURL
- The resource URL.mimtType
- The mimeType of the resource.public void addAsset(org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl.Resource resource, java.util.List<org.iso.mpeg.mxm.tEngine.relTE.schemahandler.relr.License> licenses, java.util.List<org.iso.mpeg.mxm.tEngine.eventreportTE.schemahandler.er.ERR> errs)
addAsset
in interface RvdiCreator
public org.iso.mpeg.mxm.tEngine.digitalitemTE.schemahandler.didl.DIDL generateRVDI()
RvdiCreator
generateRVDI
in interface RvdiCreator
public boolean store(java.lang.String filePath)
RvdiCreator
store
in interface RvdiCreator
public boolean advertise(java.lang.String filePath)
RvdiCreator
advertise
in interface RvdiCreator