org.hkijena.jipipe.api.parameters

Interface JIPipeCustomTextDescriptionParameter

All Known Implementing Classes:

AbstractExpressionParameter, AnnotationFilterExpression, AnnotationGeneratorExpression, AnnotationQueryExpression, ColorListParameter, ConvertingTableColumnProcessorParameterList, DataAnnotationQueryExpression, DataExportExpressionParameter, DataRowQueryExpression, DoubleAndDoublePairParameter, DoubleAndDoublePairParameter.List, DoubleList, ExpressionAndExpressionPairParameter, ExpressionAndExpressionPairParameter.List, ExpressionTableColumnGeneratorProcessor, ExpressionTableColumnGeneratorProcessorParameterList, ExpressionTableColumnProcessorParameterList, FileChooserBookmarkList, FixedMargin.List, FloatList, GeneratedParameters, GraphNodeReferenceParameter.List, HyperstackDimensionPairParameter, HyperstackDimensionPairParameter.List, IlastikEnvironment.List, InnerMargin.List, InputSlotMapParameterCollection, IntegerAndIntegerPairParameter, IntegerAndIntegerPairParameter.List, IntegerList, IntegerRange, IntegratingTableColumnProcessorParameterList, IntRangeAndIntegerPairParameter, IntRangeAndIntegerPairParameter.List, JIPipeArtifactRepositoryReferenceList, JIPipeAuthorMetadata.List, JIPipeCustomExpressionVariablesParameter, JIPipeDataDirectoryEnvironment.List, JIPipeDefaultCacheDisplayApplicationSettings, JIPipeDefaultResultImporterApplicationSettings, JIPipeDynamicParameterCollection, JIPipeExpressionParameter, JIPipeExpressionParameter.List, JIPipeImageJUpdateSiteDependency.List, JIPipeNodeTemplate.List, JIPipePythonAdapterLibraryEnvironment.List, ListParameter, LongList, Margin.List, MeasurementColumnSortOrder, MeasurementColumnSortOrder.List, NamedStringQueryExpression, NamedStringQueryExpression.List, NamedTextAnnotationGeneratorExpression, NamedTextAnnotationGeneratorExpression.List, NumericFunctionExpression, OMEROCredentialsEnvironment.List, OptionalBooleanParameter, OptionalByteParameter, OptionalColorMapParameter, OptionalColorParameter, OptionalDataAnnotationNameParameter, OptionalDataInfoRefParameter, OptionalDoubleParameter, OptionalFloatParameter, OptionalIlastikEnvironment, OptionalIntegerParameter, OptionalIntegerRange, OptionalIntModificationParameter, OptionalJIPipeAuthorMetadata, OptionalJIPipeAuthorMetadata.List, OptionalJIPipeDataDirectoryEnvironment, OptionalJIPipeExpressionParameter, OptionalJIPipePythonAdapterLibraryEnvironment, OptionalLongParameter, OptionalNodeInfoRefParameter, OptionalOMEROCredentialsEnvironment, OptionalParameter, OptionalPathParameter, OptionalProcessEnvironment, OptionalPythonEnvironment, OptionalQuantity, OptionalREnvironment, OptionalShortParameter, OptionalStringParameter, OptionalTesseractOCREnvironment, OptionalTextAnnotationNameParameter, OptionalTSOAXEnvironment, OptionalVector2dParameter, OptionalVector2iParameter, OptionalVector3dParameter, OptionalVector3iParameter, OutputSlotMapParameterCollection, PairParameter, ParameterCollectionList, PathList, PathQueryExpression, PluginCategoriesEnumParameter.List, PretrainedCellpose2SegmentationModelList, PretrainedCellpose3DenoiseModelList, PretrainedCellpose3SegmentationModelList, PretrainedOmnipose0ModelList, ProcessEnvironment.List, PythonEnvironment.List, RectangleList, REnvironment.List, ResultsTableDataList, SlotMapParameterCollection, SpotFeatureFilterParameter.List, SpotFeaturePenaltyParameter.List, StringAndStringPairParameter, StringAndStringPairParameter.List, StringList, StringMapQueryExpression, StringOrDouble.List, StringPatternExtraction.List, StringPatternExtractionFunction.List, StringQueryExpression, StringQueryExpressionAndSortOrderPairParameter, StringQueryExpressionAndSortOrderPairParameter.List, StringQueryExpressionAndStringPairParameter, StringQueryExpressionAndStringPairParameter.List, StringQueryExpressionAndStringQueryPairParameter, StringQueryExpressionAndStringQueryPairParameter.List, TableCellValueQueryExpression, TableColumnGeneratorProcessor, TableColumnGeneratorProcessorParameterList, TableColumnSourceExpressionParameter, TableColumnSourceExpressionParameter.List, TesseractOCREnvironment.List, TrackFeatureFilterParameter.List, TSOAXEnvironment.List, Vector2dParameter.List, Vector2iParameter.List, Vector3dParameter.List, Vector3iParameter.List

public interface JIPipeCustomTextDescriptionParameter

Extend parameter types with this interface to render custom text descriptions instead of JSON serialized string

Method Summary

Modifier and Type	Method and Description
String	getTextDescription() Gets the parameter as custom text description
static String	getTextDescriptionOf(Object obj) Get the text description of an object.

Method Detail

getTextDescriptionOf

static String getTextDescriptionOf(Object obj)

Get the text description of an object. Adapts to JIPipeCustomTextDescriptionParameter if the object implements it

Parameters:

obj - the object

Returns:

the text description or JSON serialized string

getTextDescription

String getTextDescription()

Gets the parameter as custom text description

Returns:

the text description