Package com.logicaldoc.ai.sampler

Class Sampler

java.lang.Object

com.logicaldoc.core.PersistentObject

com.logicaldoc.ai.sampler.Sampler

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

Direct Known Subclasses:

ChainSampler, MetadataSampler, StreamSampler

@Entity
public abstract class Sampler
extends com.logicaldoc.core.PersistentObject
implements Closeable

This is responsible of collecting all the samples required to train an AIModel

Since:

9.2

Author:

Marco Meschieri - LogicalDOC

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.logicaldoc.core.PersistentObject

DELETED_CODE_DEFAULT, DELETED_CODE_STRONG, id

Method Summary

Modifier and Type	Method	Description
abstract Sampling	collect()	Collects a list of samples
boolean	equals(Object obj)
String	getDescription()
Long	getDocId()
Long	getFolderId()
String	getLabel()
String	getName()
int	hashCode()
static Sampler	newSampler(String type)	Factory method for instantiating a new sampler
void	setDescription(String description)
void	setDocId(Long docId)
void	setFolderId(Long folderId)
void	setLabel(String label)
void	setName(String name)
String	toString()
static Set<String>	types()

Methods inherited from class com.logicaldoc.core.PersistentObject

getCreation, getDeleted, getId, getLastModified, getRecordVersion, getTenantId, setCreation, setDeleted, setId, setLastModified, setRecordVersion, setTenantId

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.io.Closeable

close

Method Details

getName

public String getName()

getLabel

public String getLabel()

setName

public void setName(String name)

setLabel

public void setLabel(String label)

getDocId

public Long getDocId()

getFolderId

public Long getFolderId()

setDocId

public void setDocId(Long docId)

setFolderId

public void setFolderId(Long folderId)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

collect

public abstract Sampling collect()
                          throws IOException,
com.logicaldoc.core.PersistenceException,
com.logicaldoc.core.automation.AutomationException

Collects a list of samples

Returns:

The iterator over the samples

Throws:

IOException - I/O Error

com.logicaldoc.core.PersistenceException - Error in the data layer

com.logicaldoc.core.automation.AutomationException - Error in the automation engine

toString

public String toString()

Overrides:

toString in class com.logicaldoc.core.PersistentObject

newSampler

public static Sampler newSampler(String type)
                          throws ClassNotFoundException,
InstantiationException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException,
NoSuchMethodException,
SecurityException

Factory method for instantiating a new sampler

Parameters:

type - Type of sampler, matches the discriminator value

Returns:

The new sampler

Throws:

ClassNotFoundException - The class loader was unable to load the sampler class

InstantiationException - Error instantiating the sampler implementation

IllegalAccessException - The implementation class exists but cannot be accessed

IllegalArgumentException - No implementation found for the given type

InvocationTargetException - The constructor raised an error

NoSuchMethodException - No empty constructor

SecurityException - The implementation class exists but cannot be accessed

types

public static Set<String> types()

hashCode

public int hashCode()

Overrides:

hashCode in class com.logicaldoc.core.PersistentObject

equals

public boolean equals(Object obj)

Overrides:

equals in class com.logicaldoc.core.PersistentObject