cz.cuni.amis.pogamut.sposh.executor
Class PrimitiveData

java.lang.Object
  cz.cuni.amis.pogamut.sposh.executor.PrimitiveData

All Implemented Interfaces:

Comparable<PrimitiveData>

public final class PrimitiveData
extends Object
implements Comparable<PrimitiveData>

Exchange container used for passing info between crawler and explorer. Contains information about primitive IAction and ISense, i.e. what is stored in PrimitiveInfo and the parameters of the primitive.

Author:

Honza

Field Summary

String	classFQN Fully qualified name of the primitive class
String	description Description of the primitive from PrimitiveInfo, can be null if no annotation.
String	name Name of the primitive from PrimitiveInfo, not necessary unique.
Set<ParamInfo>	params Parameters used by the primitive
String[]	tags Tags for primitive

Constructor Summary

PrimitiveData(String classFQN)
Create PrimitiveData about some primitive that does't have PrimitiveInfo annotation.

PrimitiveData(String classFQN, String name, String description, String[] tags, Set<ParamInfo> parameters)
Create new instance of PrimitiveData

Method Summary

int	compareTo(PrimitiveData o) Compare this data to another.
String	getClassName() Get simple class name (not FQN)
String	getHtmlDescription() Get HTML description of the metadata of this object.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

classFQN

public final String classFQN

Fully qualified name of the primitive class

name

public final String name

Name of the primitive from PrimitiveInfo, not necessary unique. Is null, if no PrimitiveInfo annotation used.

description

public final String description

Description of the primitive from PrimitiveInfo, can be null if no annotation.

tags

public final String[] tags

Tags for primitive

params

public final Set<ParamInfo> params

Parameters used by the primitive

Constructor Detail

PrimitiveData

public PrimitiveData(String classFQN)

Create PrimitiveData about some primitive that does't have PrimitiveInfo annotation.

Parameters:

classFQN - fully qualified name of the primitive class.

PrimitiveData

public PrimitiveData(String classFQN,
                     String name,
                     String description,
                     String[] tags,
                     Set<ParamInfo> parameters)

Create new instance of PrimitiveData

Parameters:

classFQN - fully qualified name of the primitive class.

name - name of primitive from PrimitiveInfo, can be null.

description - description of primitive from PrimitiveInfo, can be null.

tags - tags of the primitive

parameters - set of all parameters. Deep copy made.

Method Detail

getClassName

public String getClassName()

Get simple class name (not FQN)

Returns:

simple name of classFQN

compareTo

public int compareTo(PrimitiveData o)

Compare this data to another. First ignorcase-compare of names, if same, compare FQN of primitives.

Specified by:

compareTo in interface Comparable<PrimitiveData>

Parameters:

o - The other comparison object

Returns:

toString

public String toString()

Overrides:

toString in class Object

getHtmlDescription

public String getHtmlDescription()

Get HTML description of the metadata of this object.

Returns:

HTML description of the object.