Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/extract hidden port types #11

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Feature/extract hidden port types #11

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
defde7f
Extract port type information which is not registered via extension p…
qqilihq Apr 2, 2018
6328426
Make field `private`
qqilihq Apr 2, 2018
80d2ca0
Avoid duplicate key exceptions when creating Maps
qqilihq Apr 2, 2018
0f4ec46
Catch and log error when creating NodeModel fails
qqilihq Apr 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 43 additions & 8 deletions ...ime.jsondocgen.application/src/de/philippkatz/knime/jsondocgen/JsonNodeDocuGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
import java.lang.reflect.Method;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
Expand Down Expand Up @@ -148,6 +149,8 @@ private static void printUsage() {

private CategoryDocBuilder rootCategoryDoc;

private Map<Class<? extends PortObject>, PortType> portTypesFromNodes;

@Override
public Object start(final IApplicationContext context) throws Exception {
Object o = context.getArguments().get(IApplicationContext.APPLICATION_ARGS);
Expand Down Expand Up @@ -218,6 +221,11 @@ private void generate() throws Exception {
}
m_catPath = m_catPath.replaceAll("/", ".");

// get all port types from the nodes, as not all of them are registered via
// extension point, see here:
// https://github.com/qqilihq/knime-json-node-doc-generator/issues/10
portTypesFromNodes = new HashMap<>();

// recursively generate the node reference and the node description
// pages
generate(m_directory, root, null, rootCategoryDoc);
Expand All @@ -233,13 +241,21 @@ private void generate() throws Exception {
if (!m_skipPortDocumentation) {

Map<Class<? extends PortObject>, PortTypeDocBuilder> builders = new HashMap<>();

Map<Class<? extends PortObject>, PortType> portTypes = new HashMap<>();

// ALL port types as defined in the NodeModels' APIs
System.out.println("# port types from nodes: " + portTypesFromNodes.size());
portTypes.putAll(portTypesFromNodes);

// all registered port types indexed by the PortObject class; read this only
// once from the registry and cache it, b/c the registry creates new PortTypes
// dynamically when requesting an unknown type
Map<Class<? extends PortObject>, PortType> portTypes = PortTypeRegistry.getInstance().availablePortTypes()
.stream().collect(Collectors.toMap(PortType::getPortObjectClass, Function.identity()));
System.out.println("# port types from extension point: " + PortTypeRegistry.getInstance().availablePortTypes().size());
portTypes.putAll(PortTypeRegistry.getInstance().availablePortTypes().stream()
.collect(Collectors.toMap(PortType::getPortObjectClass, Function.identity())));

System.out.println("# port types total: " + portTypes.size());
processPorts(portTypes.keySet(), portTypes, builders);

// get the root element (all PortObjects inherit from this interface).
Expand Down Expand Up @@ -378,12 +394,18 @@ private boolean generate(final File directory, final IRepositoryObject current,
// port type information -- extract this information separately and do not merge
// with the node description's port information, because the documentation and
// the actual implementation might be inconsistent.
NodeModel nodeModel = factory.createNodeModel();
PortType[] outPorts = getPorts(nodeModel, false);
builder.setOutPorts(mergePortInfo(builder.build().outPorts, outPorts, current.getID()));

PortType[] inPorts = getPorts(nodeModel, true);
builder.setInPorts(mergePortInfo(builder.build().inPorts, inPorts, current.getID()));
try {
NodeModel nodeModel = factory.createNodeModel();
PortType[] outPorts = getPorts(nodeModel, false);
builder.setOutPorts(mergePortInfo(builder.build().outPorts, outPorts, current.getID()));
portTypesFromNodes.putAll(portsToMap(outPorts));

PortType[] inPorts = getPorts(nodeModel, true);
builder.setInPorts(mergePortInfo(builder.build().inPorts, inPorts, current.getID()));
portTypesFromNodes.putAll(portsToMap(inPorts));
} catch (Throwable t) {
System.out.println(String.format("[warn] Could not create NodeModel for %s: %s", factory, t));
}

if (deprecated) {
// there are two locations, where nodes can be set to deprecated:
Expand Down Expand Up @@ -432,6 +454,19 @@ private boolean generate(final File directory, final IRepositoryObject current,

}

/**
* Create a {@link Map} of {@link PortType}s with {@link PortObject} as key.
* Drop duplicates.
*
* @param ports
* Array of ports.
* @return Indexed ports.
*/
private static Map<Class<? extends PortObject>, PortType> portsToMap(PortType[] ports) {
return Arrays.stream(ports)
.collect(Collectors.toMap(PortType::getPortObjectClass, Function.identity(), (p1, p2) -> p1));
}

/**
* Merge port information which is defined (a) in the node's documentation, (b)
* via the {@link NodeModel}'s implementation.
Expand Down