com.exalead.mercury.mami.resources.v10

Class Resource

java.lang.Object

com.exalead.mercury.mami.resources.v10.Resource

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

SemanticResource

public class Resource
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Base class for resources.
A resource belongs to a group

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	applicationId
java.lang.String	author
java.lang.String	converterClassId
java.lang.String	description
java.util.List<KeyValue>	keyValue
java.lang.String	name
java.lang.String	type

Constructor Summary

Constructors

Constructor and Description
Resource()
Resource(Resource o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Resource.
static Resource	fromString(java.lang.String s) String representation of this Resource.
java.lang.String	getApplicationId() Application Id of the resource.
java.lang.String	getAuthor() Author of the resource.
java.lang.String	getConverterClassId() Converter Class Id.
java.lang.String	getDescription() Short description of the resource.
java.util.List<KeyValue>	getKeyValue() Configuration of the resource.
java.lang.String	getName() Name of the resource.
java.lang.String	getType() Type of the resource.
Resource	makeCopy() Creates and returns a deep copy of this Resource.
static Resource	readFrom(java.io.InputStream is) Read this Resource from an XML fragment.
void	setApplicationId(java.lang.String applicationId) Application Id of the resource.
void	setAuthor(java.lang.String author) Author of the resource.
void	setConverterClassId(java.lang.String converterClassId) Converter Class Id.
void	setDescription(java.lang.String description) Short description of the resource.
void	setName(java.lang.String name) Name of the resource.
void	setType(java.lang.String type) Type of the resource.
java.lang.String	toString() String representation of this Resource.
Resource	withApplicationId(java.lang.String applicationId)
Resource	withAuthor(java.lang.String author)
Resource	withConverterClassId(java.lang.String converterClassId)
Resource	withDescription(java.lang.String description)
Resource	withKeyValue(java.util.Collection<KeyValue> __values)
Resource	withKeyValue(KeyValue... __values) Configuration of the resource.
Resource	withName(java.lang.String name)
Resource	withType(java.lang.String type)
void	writeTo(java.io.OutputStream os) Write this Resource as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

keyValue

public java.util.List<KeyValue> keyValue

name

public java.lang.String name

type

public java.lang.String type

description

public java.lang.String description

author

public java.lang.String author

applicationId

public java.lang.String applicationId

converterClassId

public java.lang.String converterClassId

Constructor Detail

Resource

public Resource()

Resource

public Resource(Resource o)

Copy constructor

Method Detail

getKeyValue

public java.util.List<KeyValue> getKeyValue()

Configuration of the resource.

withKeyValue

public Resource withKeyValue(KeyValue... __values)

Configuration of the resource.

withKeyValue

public Resource withKeyValue(java.util.Collection<KeyValue> __values)

setName

public void setName(java.lang.String name)

Name of the resource.

getName

public java.lang.String getName()

Name of the resource.

withName

public Resource withName(java.lang.String name)

setType

public void setType(java.lang.String type)

Type of the resource.

getType

public java.lang.String getType()

Type of the resource.

withType

public Resource withType(java.lang.String type)

setDescription

public void setDescription(java.lang.String description)

Short description of the resource.

getDescription

public java.lang.String getDescription()

Short description of the resource.

withDescription

public Resource withDescription(java.lang.String description)

setAuthor

public void setAuthor(java.lang.String author)

Author of the resource.

getAuthor

public java.lang.String getAuthor()

Author of the resource.

withAuthor

public Resource withAuthor(java.lang.String author)

setApplicationId

public void setApplicationId(java.lang.String applicationId)

Application Id of the resource.
If defined, the resource can only be edited in this application.

getApplicationId

public java.lang.String getApplicationId()

Application Id of the resource.
If defined, the resource can only be edited in this application.

withApplicationId

public Resource withApplicationId(java.lang.String applicationId)

setConverterClassId

public void setConverterClassId(java.lang.String converterClassId)

Converter Class Id.
If defined, it will be used instead of the default converter associated with the resource type.

getConverterClassId

public java.lang.String getConverterClassId()

Converter Class Id.
If defined, it will be used instead of the default converter associated with the resource type.

withConverterClassId

public Resource withConverterClassId(java.lang.String converterClassId)

makeCopy

public Resource makeCopy()

Creates and returns a deep copy of this Resource.

readFrom

public static Resource readFrom(java.io.InputStream is)
                         throws javax.xml.bind.JAXBException

Read this Resource from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this Resource as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static Resource fromString(java.lang.String s)
                           throws javax.xml.bind.JAXBException,
                                  java.io.UnsupportedEncodingException

String representation of this Resource.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Resource.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this Resource.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException