com.exalead.mercury.mami.search.v20

Class MetaDesc

java.lang.Object

com.exalead.mercury.mami.search.v20.MetaDesc

All Implemented Interfaces:

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

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

Description of a meta that can be returned by the search

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	dataModelClass
java.lang.String	name
java.lang.String	nameInConfig
java.lang.String	type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this MetaDesc.
static MetaDesc	fromString(java.lang.String s) String representation of this MetaDesc.
java.lang.String	getDataModelClass() If this meta is defined by a data model, the class in which it's valid.
java.lang.String	getName() Name displayed for the meta in the result hits.
java.lang.String	getNameInConfig() Original name of the meta in the config.
java.lang.String	getType()
MetaDesc	makeCopy() Creates and returns a deep copy of this MetaDesc.
static MetaDesc	readFrom(java.io.InputStream is) Read this MetaDesc from an XML fragment.
void	setDataModelClass(java.lang.String dataModelClass) If this meta is defined by a data model, the class in which it's valid.
void	setName(java.lang.String name) Name displayed for the meta in the result hits.
void	setNameInConfig(java.lang.String nameInConfig) Original name of the meta in the config.
void	setType(java.lang.String type)
java.lang.String	toString() String representation of this MetaDesc.
MetaDesc	withDataModelClass(java.lang.String dataModelClass)
MetaDesc	withName(java.lang.String name)
MetaDesc	withNameInConfig(java.lang.String nameInConfig)
MetaDesc	withType(java.lang.String type)
void	writeTo(java.io.OutputStream os) Write this MetaDesc as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

nameInConfig

public java.lang.String nameInConfig

dataModelClass

public java.lang.String dataModelClass

type

public java.lang.String type

Constructor Detail

MetaDesc

public MetaDesc()

MetaDesc

public MetaDesc(MetaDesc o)

Copy constructor

Method Detail

setName

public void setName(java.lang.String name)

Name displayed for the meta in the result hits.

getName

public java.lang.String getName()

Name displayed for the meta in the result hits.

withName

public MetaDesc withName(java.lang.String name)

setNameInConfig

public void setNameInConfig(java.lang.String nameInConfig)

Original name of the meta in the config. This can be different from the name
for data-model-generated metas.

getNameInConfig

public java.lang.String getNameInConfig()

Original name of the meta in the config. This can be different from the name
for data-model-generated metas.

withNameInConfig

public MetaDesc withNameInConfig(java.lang.String nameInConfig)

setDataModelClass

public void setDataModelClass(java.lang.String dataModelClass)

If this meta is defined by a data model, the class in which it's valid.

getDataModelClass

public java.lang.String getDataModelClass()

If this meta is defined by a data model, the class in which it's valid.

withDataModelClass

public MetaDesc withDataModelClass(java.lang.String dataModelClass)

setType

public void setType(java.lang.String type)

getType

public java.lang.String getType()

withType

public MetaDesc withType(java.lang.String type)

makeCopy

public MetaDesc makeCopy()

Creates and returns a deep copy of this MetaDesc.

readFrom

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

Read this MetaDesc 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 MetaDesc as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this MetaDesc.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this MetaDesc.

Overrides:

toString in class java.lang.Object

check

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

Checks this MetaDesc.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException