Examples with StringParameterValue au.gov.asd.tac.constellation.plugins.parameters.types.StringParameterValue used on opensource projects

Example 1 with StringParameterValue

use of au.gov.asd.tac.constellation.plugins.parameters.types.StringParameterValue in project constellation by constellation-app.

the class CreateVertexTypePlugin method createParameters.

@Override
public PluginParameters createParameters() {
    final PluginParameters params = new PluginParameters();
    final PluginParameter<StringParameterValue> nameParam = StringParameterType.build(NAME_PARAMETER_ID);
    nameParam.setName("Name");
    nameParam.setDescription("The name of the new vertex type");
    nameParam.setStringValue(null);
    params.addParameter(nameParam);
    final PluginParameter<StringParameterValue> descriptionParam = StringParameterType.build(DESCRIPTION_PARAMETER_ID);
    descriptionParam.setName("Description");
    descriptionParam.setDescription("The description of the new vertex type");
    descriptionParam.setStringValue(null);
    params.addParameter(descriptionParam);
    final PluginParameter<ColorParameterValue> colorParam = ColorParameterType.build(COLOR_PARAMETER_ID);
    colorParam.setName("Color");
    colorParam.setDescription("The color of the new vertex type");
    colorParam.setStringValue(ConstellationColor.GREY.getName());
    params.addParameter(colorParam);
    final PluginParameter<StringParameterValue> fgIconParam = StringParameterType.build(FG_ICON_PARAMETER_ID);
    fgIconParam.setName("Foreground Icon");
    fgIconParam.setDescription("The name of the foreground icon of the new vertex type");
    fgIconParam.setStringValue(CharacterIconProvider.CHAR_003F.getExtendedName());
    params.addParameter(fgIconParam);
    final PluginParameter<StringParameterValue> bgIconParam = StringParameterType.build(BG_ICON_PARAMETER_ID);
    bgIconParam.setName("Background Icon");
    bgIconParam.setDescription("The name of the background icon of the new vertex type");
    bgIconParam.setStringValue(DefaultIconProvider.FLAT_SQUARE.getExtendedName());
    params.addParameter(bgIconParam);
    final PluginParameter<StringParameterValue> detectionRegexParam = StringParameterType.build(DETECTION_REGEX_PARAMETER_ID);
    detectionRegexParam.setName("Detection Regular Expression");
    detectionRegexParam.setDescription("The detection regular expression (case of the new vertex type");
    detectionRegexParam.setStringValue(null);
    params.addParameter(detectionRegexParam);
    final PluginParameter<StringParameterValue> validationRegexParam = StringParameterType.build(VALIDATION_REGEX_PARAMETER_ID);
    validationRegexParam.setName("Validation Regular Expression");
    validationRegexParam.setDescription("The detection regular expression of the new vertex type");
    validationRegexParam.setStringValue(null);
    params.addParameter(validationRegexParam);
    final PluginParameter<StringParameterValue> superTypeParam = StringParameterType.build(SUPER_TYPE_PARAMETER_ID);
    superTypeParam.setName("Super Type");
    superTypeParam.setDescription("The name of the super type of the new vertex type");
    superTypeParam.setStringValue(null);
    params.addParameter(superTypeParam);
    final PluginParameter<StringParameterValue> overriddenTypeParam = StringParameterType.build(OVERRIDDEN_TYPE_PARAMETER_ID);
    overriddenTypeParam.setName("Overridden Type");
    overriddenTypeParam.setDescription("The name of the overridden type of the new vertex type");
    overriddenTypeParam.setStringValue(null);
    params.addParameter(overriddenTypeParam);
    final PluginParameter<BooleanParameterValue> incompleteParam = BooleanParameterType.build(INCOMPLETE_PARAMETER_ID);
    incompleteParam.setName("Incomplete");
    incompleteParam.setDescription("Is the new vertex type incomplete?");
    incompleteParam.setBooleanValue(false);
    params.addParameter(incompleteParam);
    return params;
}

Example 2 with StringParameterValue

use of au.gov.asd.tac.constellation.plugins.parameters.types.StringParameterValue in project constellation by constellation-app.

the class TestParametersPlugin method createParameters.

@Override
public PluginParameters createParameters() {
    final PluginParameters params = new PluginParameters();
    final String css = TestParametersPlugin.class.getResource("resources/test.css").toExternalForm();
    final BooleanParameterValue selectedpv = new BooleanParameterValue(true);
    selectedpv.setGuiInit(control -> {
        final CheckBox field = (CheckBox) control;
        field.getStylesheets().add(css);
    });
    final PluginParameter<BooleanParameterValue> selected = BooleanParameterType.build(SELECTED_PARAMETER_ID, selectedpv);
    selected.setName("Use selected");
    selected.setDescription("Only use selected elements");
    params.addParameter(selected);
    final PluginParameter<StringParameterValue> queryName = CoreGlobalParameters.QUERY_NAME_PARAMETER;
    params.addParameter(queryName);
    final PluginParameter<DateTimeRangeParameterValue> dt = CoreGlobalParameters.DATETIME_RANGE_PARAMETER;
    params.addParameter(dt);
    final PluginParameter<StringParameterValue> string1 = StringParameterType.build(TEST1_PARAMETER_ID);
    string1.setName("Test1");
    string1.setDescription("A test string");
    string1.setStringValue("Plugh.");
    params.addParameter(string1);
    final StringParameterValue string2pv = new StringParameterValue();
    string2pv.setGuiInit(control -> {
        final TextArea field = (TextArea) control;
        field.getStylesheets().add(css);
    });
    final PluginParameter<StringParameterValue> string2 = StringParameterType.build(TEST2_PARAMETER_ID, string2pv);
    string2.setName("Test2");
    string2.setDescription("A two line test string");
    StringParameterType.setLines(string2, 2);
    params.addParameter(string2);
    final PluginParameter<PasswordParameterValue> passwd = PasswordParameterType.build(PASSWORD_PARAMETER_ID);
    passwd.setName("Password");
    passwd.setDescription("Everyone needs a password");
    params.addParameter(passwd);
    final PluginParameter<LocalDateParameterValue> date = LocalDateParameterType.build(LOCAL_DATE_PARAMETER_ID);
    date.setName("Date");
    date.setDescription("Pick a day");
    date.setLocalDateValue(LocalDate.of(2001, Month.JANUARY, 1));
    params.addParameter(date);
    final List<GraphElementTypeParameterValue> elementTypeOptions = new ArrayList<>();
    for (final GraphElementType elementType : GraphElementType.values()) {
        elementTypeOptions.add(new GraphElementTypeParameterValue(elementType));
    }
    final PluginParameter<SingleChoiceParameterValue> elementType = SingleChoiceParameterType.build(ELEMENT_TYPE_PARAMETER_ID, GraphElementTypeParameterValue.class);
    elementType.setName("Graph element type");
    elementType.setDescription("Graph element type");
    SingleChoiceParameterType.setOptionsData(elementType, elementTypeOptions);
    params.addParameter(elementType);
    // A single choice list with a subtype of String.
    final SingleChoiceParameterValue robotpv = new SingleChoiceParameterValue(StringParameterValue.class);
    robotpv.setGuiInit(control -> {
        // control will be of type ComboBox<ParameterValue> which extends from Region
        @SuppressWarnings("unchecked") final ComboBox<ParameterValue> field = (ComboBox<ParameterValue>) control;
        final Image img = new Image(ALIEN_ICON);
        field.setCellFactory((ListView<ParameterValue> param) -> new ListCell<ParameterValue>() {

            @Override
            protected void updateItem(final ParameterValue item, final boolean empty) {
                super.updateItem(item, empty);
                this.setText(empty ? "" : item.toString());
                final float f = empty ? 0 : item.toString().length() / 11F;
                final Color c = Color.color(1 - f / 2F, 0, 0);
                setTextFill(c);
                setGraphic(new ImageView(img));
            }
        });
    });
    final PluginParameter<SingleChoiceParameterValue> robotOptions = SingleChoiceParameterType.build(ROBOT_PARAMETER_ID, robotpv);
    robotOptions.setName("Robot options");
    robotOptions.setDescription("A list of robots to choose from");
    // Use the helper method to add string options.
    SingleChoiceParameterType.setOptions(robotOptions, Arrays.asList("Bender", "Gort", "Maximillian", "Robbie", "Tom Servo"));
    // Create a ParameterValue of the underlying type (in this case, String) to set the default choice.
    final StringParameterValue robotChoice = new StringParameterValue("Gort");
    SingleChoiceParameterType.setChoiceData(robotOptions, robotChoice);
    params.addParameter(robotOptions);
    final PluginParameter<ParameterValue> buttonParam = ActionParameterType.build(REFRESH_PARAMETER_ID);
    buttonParam.setName("Refresh");
    buttonParam.setDescription("Update the available robots");
    params.addParameter(buttonParam);
    final PluginParameter<MultiChoiceParameterValue> planetOptions = MultiChoiceParameterType.build(PLANETS_PARAMETER_ID);
    planetOptions.setName("Planets");
    planetOptions.setDescription("Some planets");
    MultiChoiceParameterType.setOptions(planetOptions, Arrays.asList("Mercury", "Venus", "Earth", "Mars", "Jupiter", "Saturn", "Uranus", "Neptune", "Coruscant"));
    final List<String> checked = new ArrayList<>();
    checked.add("Earth");
    MultiChoiceParameterType.setChoices(planetOptions, checked);
    params.addParameter(planetOptions);
    final PluginParameter<IntegerParameterValue> diceOptions = IntegerParameterType.build(DICE_PARAMETER_ID);
    diceOptions.setName("Dice");
    diceOptions.setDescription("2d6");
    IntegerParameterType.setMinimum(diceOptions, 2);
    IntegerParameterType.setMaximum(diceOptions, 12);
    diceOptions.setIntegerValue(7);
    params.addParameter(diceOptions);
    final PluginParameter<FloatParameterValue> probability = FloatParameterType.build(PROBABILITY_PARAMETER_ID);
    probability.setName("Probability");
    probability.setDescription("0 <= p <= 1");
    FloatParameterType.setMinimum(probability, 0F);
    FloatParameterType.setMaximum(probability, 1F);
    FloatParameterType.setStep(probability, 0.1F);
    probability.setFloatValue(1F);
    params.addParameter(probability);
    final PluginParameter<FileParameterValue> openFileParam = FileParameterType.build(INPUT_FILE_PARAMETER_ID);
    openFileParam.setName("Input file");
    openFileParam.setDescription("A file to read stuff from");
    params.addParameter(openFileParam);
    final PluginParameter<FileParameterValue> saveFileParam = FileParameterType.build(OUTPUT_FILE_PARAMETER_ID);
    saveFileParam.setName("Output file");
    saveFileParam.setDescription("A file to write stuff to");
    FileParameterType.setKind(saveFileParam, FileParameterType.FileParameterKind.SAVE);
    FileParameterType.setFileFilters(saveFileParam, new FileChooser.ExtensionFilter("Text files", "*.txt"));
    params.addParameter(saveFileParam);
    final PluginParameter<ColorParameterValue> color = ColorParameterType.build(COLOR_PARAMETER_ID);
    color.setName("Color");
    color.setDescription("Your favourite colour");
    color.setColorValue(ConstellationColor.BLUE);
    params.addParameter(color);
    final PluginParameter<BooleanParameterValue> crash = BooleanParameterType.build(CRASH_PARAMETER_ID);
    crash.setName("Crash");
    crash.setDescription("Simulate plugin failure");
    params.addParameter(crash);
    final PluginParameter<SingleChoiceParameterValue> interactionOptions = SingleChoiceParameterType.build(INTERACTION_PARAMETER_ID);
    interactionOptions.setName("Interaction level");
    interactionOptions.setDescription("Interaction level for some interaction with the user");
    SingleChoiceParameterType.setOptions(interactionOptions, Arrays.asList(NONE, DEBUG, INFO, WARNING, ERROR, FATAL));
    params.addParameter(interactionOptions);
    final PluginParameter<SingleChoiceParameterValue> levelOptions = SingleChoiceParameterType.build(LEVEL_PARAMETER_ID);
    levelOptions.setName("PluginException level");
    levelOptions.setDescription("PluginException level to throw an exception at");
    levelOptions.setHelpID("not.actually.helpful");
    SingleChoiceParameterType.setOptions(levelOptions, Arrays.asList(NONE, DEBUG, INFO, WARNING, ERROR, FATAL));
    params.addParameter(levelOptions);
    final PluginParameter<IntegerParameterValue> sleepParam = IntegerParameterType.build(SLEEP_PARAMETER_ID);
    sleepParam.setName("Sleep");
    sleepParam.setDescription("Seconds");
    IntegerParameterType.setMinimum(sleepParam, 0);
    IntegerParameterType.setMaximum(sleepParam, 20);
    sleepParam.setIntegerValue(0);
    params.addParameter(sleepParam);
    params.addController(SELECTED_PARAMETER_ID, (final PluginParameter<?> master, final Map<String, PluginParameter<?>> parameters, final ParameterChange change) -> {
        if (change == ParameterChange.VALUE) {
            final boolean masterBoolean = master.getBooleanValue();
            // TEST1_PARAMETER will always be of type StringParameter
            @SuppressWarnings("unchecked") final PluginParameter<StringParameterValue> t1 = (PluginParameter<StringParameterValue>) parameters.get(TEST1_PARAMETER_ID);
            t1.setEnabled(masterBoolean);
            // TEST1_PARAMETER will always be of type StringParameter
            @SuppressWarnings("unchecked") final PluginParameter<StringParameterValue> t2 = (PluginParameter<StringParameterValue>) parameters.get(TEST2_PARAMETER_ID);
            t2.setEnabled(masterBoolean);
            // PLANETS_PARAMETER will always be of type MultiChoiceParameter
            @SuppressWarnings("unchecked") final PluginParameter<MultiChoiceParameterValue> p = (PluginParameter<MultiChoiceParameterValue>) parameters.get(PLANETS_PARAMETER_ID);
            p.setEnabled(masterBoolean);
            // DICE_PARAMETER will always be of type IntegerParameter
            @SuppressWarnings("unchecked") final PluginParameter<IntegerParameterValue> d = (PluginParameter<IntegerParameterValue>) parameters.get(DICE_PARAMETER_ID);
            d.setEnabled(masterBoolean);
            // COLOR_PARAMETER will always be of type ColorParameter
            @SuppressWarnings("unchecked") final PluginParameter<ColorParameterValue> c = (PluginParameter<ColorParameterValue>) parameters.get(COLOR_PARAMETER_ID);
            c.setVisible(masterBoolean);
        }
    });
    params.addController(REFRESH_PARAMETER_ID, (final PluginParameter<?> master, final Map<String, PluginParameter<?>> parameters, final ParameterChange change) -> {
        if (change == ParameterChange.NO_CHANGE) {
            // button pressed
            // ROBOT_PARAMETER will always be of type SingleChoiceParameter
            @SuppressWarnings("unchecked") final PluginParameter<SingleChoiceParameterValue> robot = (PluginParameter<SingleChoiceParameterValue>) parameters.get(ROBOT_PARAMETER_ID);
            final int n = (int) (System.currentTimeMillis() % 100);
            SingleChoiceParameterType.setOptions(robot, Arrays.asList("Kryton " + n, "C-3PO " + n, "R2-D2 " + n));
            SingleChoiceParameterType.setChoice(robot, "C-3PO " + n);
        }
    });
    return params;
}

Example 3 with StringParameterValue

use of au.gov.asd.tac.constellation.plugins.parameters.types.StringParameterValue in project constellation by constellation-app.

the class SplitNodesPlugin method createParameters.

@Override
public PluginParameters createParameters() {
    final PluginParameters params = new PluginParameters();
    final PluginParameter<StringParameterValue> split = StringParameterType.build(SPLIT_PARAMETER_ID);
    split.setName("Split Character(s)");
    split.setDescription("A new term will be extracted from the first instance of this character(s) in the Identifier");
    split.setStringValue(null);
    params.addParameter(split);
    final PluginParameter<BooleanParameterValue> duplicateTransactionsParameter = BooleanParameterType.build(DUPLICATE_TRANSACTIONS_PARAMETER_ID);
    duplicateTransactionsParameter.setName("Duplicate Transactions");
    duplicateTransactionsParameter.setDescription("Duplicate transactions for split nodes");
    duplicateTransactionsParameter.setBooleanValue(false);
    params.addParameter(duplicateTransactionsParameter);
    final PluginParameter<SingleChoiceParameterValue> transactionType = SingleChoiceParameterType.build(TRANSACTION_TYPE_PARAMETER_ID);
    transactionType.setName("Transaction Type");
    transactionType.setDescription("Set the type of transaction between nodes");
    params.addParameter(transactionType);
    final PluginParameter<BooleanParameterValue> allOccurrences = BooleanParameterType.build(ALL_OCCURRENCES_PARAMETER_ID);
    allOccurrences.setName("Split on All Occurrences");
    allOccurrences.setDescription("Choose to split on all instances of the character(s) rather than just the first instance");
    allOccurrences.setBooleanValue(false);
    params.addParameter(allOccurrences);
    final PluginParameter<BooleanParameterValue> completeSchema = BooleanParameterType.build(COMPLETE_WITH_SCHEMA_OPTION_ID);
    completeSchema.setName("Complete with Schema");
    completeSchema.setDescription("Choose to apply the type schema to the graph");
    completeSchema.setBooleanValue(true);
    params.addParameter(completeSchema);
    params.addController(DUPLICATE_TRANSACTIONS_PARAMETER_ID, (master, parameters, change) -> {
        if (change == ParameterChange.VALUE) {
            final boolean splitIntoSameLevel = master.getBooleanValue();
            parameters.get(TRANSACTION_TYPE_PARAMETER_ID).setEnabled(!splitIntoSameLevel);
        }
    });
    return params;
}

Example 4 with StringParameterValue

use of au.gov.asd.tac.constellation.plugins.parameters.types.StringParameterValue in project constellation by constellation-app.

the class ExtractWordsFromTextPluginNGTest method testUpdateParameters.

/**
 * Test updateParameters
 */
@Test
public void testUpdateParameters() {
    ExtractWordsFromTextPlugin instance = new ExtractWordsFromTextPlugin();
    PluginParameters parameters = new PluginParameters();
    final PluginParameter<SingleChoiceParameterValue> attributeType = SingleChoiceParameterType.build(ATTRIBUTE_PARAMETER_ID);
    parameters.addParameter(attributeType);
    final PluginParameter<StringParameterValue> textParameter = StringParameterType.build(WORDS_PARAMETER_ID);
    textParameter.setStringValue("text");
    parameters.addParameter(textParameter);
    final PluginParameter<BooleanParameterValue> useRegexParameter = BooleanParameterType.build(USE_REGEX_PARAMETER_ID);
    useRegexParameter.setBooleanValue(true);
    parameters.addParameter(useRegexParameter);
    Graph graph1 = new DualGraph(graph.getSchema(), graph);
    instance.updateParameters(graph1, parameters);
    assertEquals(parameters.getParameters().size(), 3);
    assertTrue(parameters.hasParameter(ExtractWordsFromTextPlugin.ATTRIBUTE_PARAMETER_ID));
    assertEquals(parameters.getParameters().get(ExtractWordsFromTextPlugin.WORDS_PARAMETER_ID).getStringValue(), "text");
    assertEquals(parameters.getParameters().get(ExtractWordsFromTextPlugin.USE_REGEX_PARAMETER_ID).getBooleanValue(), true);
    assertFalse(parameters.hasParameter(ExtractWordsFromTextPlugin.SELECTED_ONLY_PARAMETER_ID));
    parameters = instance.createParameters();
    instance.updateParameters(graph1, parameters);
    assertEquals(parameters.getParameters().size(), 11);
    assertTrue(parameters.hasParameter(ExtractWordsFromTextPlugin.SELECTED_ONLY_PARAMETER_ID));
}

Example 5 with StringParameterValue

use of au.gov.asd.tac.constellation.plugins.parameters.types.StringParameterValue in project constellation by constellation-app.

the class SendToEmailClientPlugin method createParameters.

@Override
public PluginParameters createParameters() {
    final PluginParameters parameters = new PluginParameters();
    final PluginParameter<StringParameterValue> toEmailParameter = StringParameterType.build(TO_EMAIL_PARAMETER_ID);
    toEmailParameter.setName("To Email");
    toEmailParameter.setDescription("The to email recipient");
    parameters.addParameter(toEmailParameter);
    final PluginParameter<StringParameterValue> ccEmailParameter = StringParameterType.build(CC_EMAIL_PARAMETER_ID);
    ccEmailParameter.setName("CC Email");
    ccEmailParameter.setDescription("The cc email recipient");
    parameters.addParameter(ccEmailParameter);
    final PluginParameter<StringParameterValue> subjectParameter = StringParameterType.build(SUBJECT_PARAMETER_ID);
    subjectParameter.setName("Subject");
    subjectParameter.setDescription("The subject for the email");
    parameters.addParameter(subjectParameter);
    final PluginParameter<StringParameterValue> bodyParameter = StringParameterType.build(BODY_PARAMETER_ID);
    bodyParameter.setName("Body");
    bodyParameter.setDescription("The body of the email");
    parameters.addParameter(bodyParameter);
    return parameters;
}