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

Class OptionalDataAnnotationNameParameter

java.lang.Object

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

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

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

All Implemented Interfaces:

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.extensions.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(JIPipeIssueReport report) Generates a validity report

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

setNewInstance

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

getContent, getContentClass, getContentOrDefault, isEnabled, setContent, setEnabled, toString

Methods inherited from class java.lang.Object

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

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

generateValidityReport

Constructor Detail

OptionalDataAnnotationNameParameter

public OptionalDataAnnotationNameParameter()

OptionalDataAnnotationNameParameter

public OptionalDataAnnotationNameParameter(OptionalStringParameter other)

OptionalDataAnnotationNameParameter

public OptionalDataAnnotationNameParameter(String value,
                                           boolean enabled)

Method Detail

reportValidity

public void reportValidity(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Parameters:

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