atp-mipt / ljv Goto Github PK

Proposal

Can we add methods like:

// Set the same label for all objects of the given class
public LJV setClassLabel(Class<?> cz, String label);

// Set a label for an individual object of the given class
public <T> LJV setObjectLabelProvider(Class<T> cz, ObjectLabelProvider<T> labelProvider);

// Set a label for individual objects of the given class (only if it's a specific field)
public <T> LJV setObjectLabelProvider(Field field, Class<T> cz, ObjectLabelProvider<T> labelProvider);

@FunctionalInterface
public interface ObjectLabelProvider<T> {
    String getLabel(T obj);
}

Examples

var p = new SimpleImmutableEntry(1, 2);
browse(new LJV().setClassLabel(SimpleImmutableEntry.class, "Entry"), p);

var list = new ArrayList<>();
list.add(1);
list.add(2);
browse(new LJV()
        .setTreatAsPrimitive(Integer.class)
        .setObjectLabelProvider(ArrayList.class, lst -> lst.getClass().getName() + "@" + System.identityHashCode(lst)),
        list);

var string = "hello";
browse(new LJV()
        .setObjectLabelProvider(String.class, str -> str)
        .setObjectLabelProvider(byte.class, b -> "0x" + Integer.toHexString(Byte.toUnsignedInt(b))),
        string);

Issues

• Primitives. Should we add IntLabelProvider, LongLabelProvider, ByteLabelProvider or use setObjectLabelProvider(int.class, (Integer x) -> )?
• Inheritance. Should setClassLabel(List.class, ...) work only for List or ArrayList, LinkedList and other subclasses?

Object[] array = {};
browse(new LJV(), array);

Graphviz Online doesn't render and reports an error:

in label of node n1

Any plan for ide plugins?

The artifact org.atp-fivt:ljv:1.01 uses org.atp-fivt:ljv-parent:${revision} as its parent, but that artifact is not deployed to Maven Central.

This causes attempts to use ljv on a machine that hasn't built the package from source to fail with the error:

Could not resolve dependencies for project net.kemitix.binder:binder-app:jar:1.0.0-SNAPSHOT: Failed to collect dependencies at org.atp-fivt:ljv:jar:1.01: Failed to read artifact descriptor for org.atp-fivt:ljv:jar:1.01: Failure to find org.atp-fivt:ljv-parent:pom:${revision} in https://repo.maven.apache.org/maven2 was cached in the local repository, resolution will not be reattempted until the update interval of central has elapsed or updates are forced.

How do I show the relation between multiple Objects?

Let's say I have a class :

public class Node {

    int data = 5;

}

The only way to show how n1,n2,n are connected is shown below

public static void main(String[] args) {
       Node n = new Node();

       Node n1 = n;
       Node n2 = n;


       System.out.println(new LJV().drawGraph(new Object[]{n1,n2,n}));
   }

It would be great If I can do it as below.

LJV ljv = new LJV();

ljv.add(n);
ljv.add(n1);
ljv.add(n2);

ljv.drawGraph();

is this possible currently?

please let me know.