com.exalead.papi.helper

Class Meta

java.lang.Object

com.exalead.papi.helper.Meta

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SecurityMeta

public class Meta
extends java.lang.Object
implements java.io.Serializable

Meta that can be associated with a document. Meta data is any additional information associated to a document. A list of Meta data items (or meta) can be associated to a document and are interpreted by the document processing pipelines to set field values or add categories to the document.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name Meta name.
protected java.lang.String	value Meta value .

Constructor Summary

Constructors

Constructor and Description
Meta(java.lang.String name, java.lang.String value) Constructor specifying the meta data name and value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Helper function to compare a meta with another object.
java.lang.String	getName() Get the meta name.
java.lang.String	getValue() Get the meta value.
int	hashCode()
void	setName(java.lang.String name) Set the meta name.
void	setValue(java.lang.String value) Set the meta value.
java.lang.String	toString() Simple meta serializer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

protected java.lang.String name

Meta name.

value

protected java.lang.String value

Meta value .

Constructor Detail

Meta

public Meta(java.lang.String name,
            java.lang.String value)

Constructor specifying the meta data name and value.

Parameters:

name - meta name. Cannot be null.

value - meta value.

Method Detail

getName

public java.lang.String getName()

Get the meta name.

Returns:

the Meta name

getValue

public java.lang.String getValue()

Get the meta value.

Returns:

the value

setName

public void setName(java.lang.String name)

Set the meta name.

Parameters:

name -

setValue

public void setValue(java.lang.String value)

Set the meta value.

Parameters:

value -

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Helper function to compare a meta with another object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object with which the current meta should be compared.

Returns:

true if the compared object is also a meta with the same name and value as the current meta.

toString

public java.lang.String toString()

Simple meta serializer.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the meta.