Interface ItemBuilder


  • public interface ItemBuilder
    Builds and returns new Item instances.

    Items are the visual elements representing the graph and are built by item builders from the graph object.

    An item builder should build only a single type of items. Items are defined by a type Item.getType(), which needs to be the same as the value returned by getType(). In other words if this builder is building Node.Item items, it should return Node.Item as a type.

    Item builders are singleton services and implementations need to add the following annotation to be recognized by the system:

    @ServiceProvider(service=ItemBuilder.class)

    Author:
    Yudi Xue, Mathieu Bastian
    • Method Detail

      • getItems

        Item[] getItems​(Graph graph)
        Build items from the graph.
        Parameters:
        graph - the graph to build items from
        Returns:
        an array of new items, from the same type returned by getType()
      • getType

        String getType()
        Returns the type of this builder.

        The type should always match the type of Item the builder is building. For instance if the builder is building Item.Node type, this method should return Item.Node.

        Returns:
        the builder item type.