org.hkijena.jipipe.plugins.parameters.library.primitives.optional

Class OptionalDataAnnotationNameParameter

java.lang.Object

org.hkijena.jipipe.plugins.parameters.api.optional.OptionalParameter<String>

org.hkijena.jipipe.plugins.parameters.library.primitives.optional.OptionalStringParameter

org.hkijena.jipipe.plugins.parameters.library.primitives.optional.OptionalDataAnnotationNameParameter

All Implemented Interfaces:

JIPipeCustomTextDescriptionParameter, JIPipeValidatable

public class OptionalDataAnnotationNameParameter
extends OptionalStringParameter
implements JIPipeValidatable

Parameter used for creating annotations

Nested Class Summary

Nested classes/interfaces inherited from class org.hkijena.jipipe.plugins.parameters.api.optional.OptionalParameter

OptionalParameter.Deserializer<T>, OptionalParameter.Serializer

Constructor Summary

Constructors

Constructor and Description
OptionalDataAnnotationNameParameter()
OptionalDataAnnotationNameParameter(OptionalStringParameter other)
OptionalDataAnnotationNameParameter(String value, boolean enabled)

Method Summary

Modifier and Type	Method and Description
void	addAnnotationIfEnabled(Collection<JIPipeDataAnnotation> annotations, JIPipeData value) Adds the annotation with given value of the parameter is enabled
JIPipeDataAnnotation	createAnnotation(JIPipeData value) Creates a new annotation with the defined name and value
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report

Methods inherited from class org.hkijena.jipipe.plugins.parameters.library.primitives.optional.OptionalStringParameter

setNewInstance

Methods inherited from class org.hkijena.jipipe.plugins.parameters.api.optional.OptionalParameter

equals, getContent, getContentClass, getContentOrDefault, getTextDescription, hashCode, isEnabled, setContent, setEnabled, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.validation.JIPipeValidatable

generateValidityReport

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeCustomTextDescriptionParameter

getTextDescriptionOf

Constructor Detail

OptionalDataAnnotationNameParameter

public OptionalDataAnnotationNameParameter()

OptionalDataAnnotationNameParameter

public OptionalDataAnnotationNameParameter(OptionalStringParameter other)

OptionalDataAnnotationNameParameter

public OptionalDataAnnotationNameParameter(String value,
                                           boolean enabled)

Method Detail

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Parameters:

reportContext - the report context

report - the report to be added to

createAnnotation

public JIPipeDataAnnotation createAnnotation(JIPipeData value)

Creates a new annotation with the defined name and value

Parameters:

value - the value of the annotation

Returns:

annotation

addAnnotationIfEnabled

public void addAnnotationIfEnabled(Collection<JIPipeDataAnnotation> annotations,
                                   JIPipeData value)

Adds the annotation with given value of the parameter is enabled

Parameters:

annotations - list of annotations

value - the value