You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2015/03/27 11:17:44 UTC
[3/4] camel git commit: CAMEL-8558: Camel component docs now include
a human readable title for the component names.
CAMEL-8558: Camel component docs now include a human readable title for the component names.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/2333474e
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/2333474e
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/2333474e
Branch: refs/heads/camel-2.15.x
Commit: 2333474efe08e2ab05382c6d9ab340e69980b08c
Parents: 98d0bc4
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Mar 27 10:30:48 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Mar 27 11:19:45 2015 +0100
----------------------------------------------------------------------
.../camel/commands/AbstractCamelController.java | 12 +++++
.../commands/CatalogComponentListCommand.java | 2 +-
.../commands/CatalogDataFormatListCommand.java | 51 +++++++++-----------
.../commands/CatalogLanguageListCommand.java | 49 ++++++++++---------
4 files changed, 63 insertions(+), 51 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/2333474e/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/AbstractCamelController.java
----------------------------------------------------------------------
diff --git a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/AbstractCamelController.java b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/AbstractCamelController.java
index b5ddf3c..5acb526 100644
--- a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/AbstractCamelController.java
+++ b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/AbstractCamelController.java
@@ -170,6 +170,7 @@ public abstract class AbstractCamelController implements CamelController {
String json = catalog.dataFormatJSonSchema(name);
List<Map<String, String>> rows = JsonSchemaHelper.parseJsonSchema("dataformat", json, false);
+ String title = null;
String description = null;
String label = null;
String modelName = name;
@@ -186,6 +187,8 @@ public abstract class AbstractCamelController implements CamelController {
for (Map<String, String> row : rows) {
if (row.containsKey("modelName")) {
modelName = row.get("modelName");
+ } else if (row.containsKey("title")) {
+ title = row.get("title");
} else if (row.containsKey("description")) {
description = row.get("description");
} else if (row.containsKey("label")) {
@@ -207,6 +210,9 @@ public abstract class AbstractCamelController implements CamelController {
row.put("name", name);
row.put("modelName", modelName);
row.put("status", status);
+ if (title != null) {
+ row.put("title", title);
+ }
if (description != null) {
row.put("description", description);
}
@@ -249,6 +255,7 @@ public abstract class AbstractCamelController implements CamelController {
String json = catalog.languageJSonSchema(name);
List<Map<String, String>> rows = JsonSchemaHelper.parseJsonSchema("language", json, false);
+ String title = null;
String description = null;
String label = null;
String modelName = name;
@@ -265,6 +272,8 @@ public abstract class AbstractCamelController implements CamelController {
for (Map<String, String> row : rows) {
if (row.containsKey("modelName")) {
modelName = row.get("modelName");
+ } else if (row.containsKey("title")) {
+ description = row.get("title");
} else if (row.containsKey("description")) {
description = row.get("description");
} else if (row.containsKey("label")) {
@@ -286,6 +295,9 @@ public abstract class AbstractCamelController implements CamelController {
row.put("name", name);
row.put("modelName", modelName);
row.put("status", status);
+ if (title != null) {
+ row.put("title", description);
+ }
if (description != null) {
row.put("description", description);
}
http://git-wip-us.apache.org/repos/asf/camel/blob/2333474e/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogComponentListCommand.java
----------------------------------------------------------------------
diff --git a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogComponentListCommand.java b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogComponentListCommand.java
index 548073b..59fe9da 100644
--- a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogComponentListCommand.java
+++ b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogComponentListCommand.java
@@ -67,7 +67,7 @@ public class CatalogComponentListCommand extends AbstractCamelCommand {
out.println(String.format(headerFormat, "-----", "------", "-----", "----------------"));
} else {
out.println(String.format(headerFormat, TITLE_COLUMN_LABEL, DESCRIPTION_COLUMN_LABEL));
- out.println(String.format(headerFormat, "----", "-----------"));
+ out.println(String.format(headerFormat, "-----", "-----------"));
}
for (final Map<String, String> component : components) {
if (verbose) {
http://git-wip-us.apache.org/repos/asf/camel/blob/2333474e/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogDataFormatListCommand.java
----------------------------------------------------------------------
diff --git a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogDataFormatListCommand.java b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogDataFormatListCommand.java
index 814e1de..391105f 100644
--- a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogDataFormatListCommand.java
+++ b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogDataFormatListCommand.java
@@ -26,6 +26,7 @@ import java.util.Map;
*/
public class CatalogDataFormatListCommand extends AbstractCamelCommand {
+ private static final String TITLE_COLUMN_LABEL = "Title";
private static final String NAME_COLUMN_LABEL = "Name";
private static final String LABEL_COLUMN_LABEL = "Label";
private static final String MAVEN_COLUMN_LABEL = "Maven Coordinate";
@@ -62,30 +63,26 @@ public class CatalogDataFormatListCommand extends AbstractCamelCommand {
final String rowFormat = buildFormatString(columnWidths, false);
if (verbose) {
- out.println(String.format(headerFormat, NAME_COLUMN_LABEL, LABEL_COLUMN_LABEL, MAVEN_COLUMN_LABEL, DESCRIPTION_COLUMN_LABEL));
- out.println(String.format(headerFormat, "----", "-----", "----------------", "-----------"));
+ out.println(String.format(headerFormat, TITLE_COLUMN_LABEL, NAME_COLUMN_LABEL, LABEL_COLUMN_LABEL, MAVEN_COLUMN_LABEL));
+ out.println(String.format(headerFormat, "-----", "----", "-----", "----------------"));
} else {
- out.println(String.format(headerFormat, NAME_COLUMN_LABEL, LABEL_COLUMN_LABEL, MAVEN_COLUMN_LABEL));
- out.println(String.format(headerFormat, "----", "-----", "----------------"));
+ out.println(String.format(headerFormat, TITLE_COLUMN_LABEL, DESCRIPTION_COLUMN_LABEL));
+ out.println(String.format(headerFormat, "-----", "-----------"));
}
for (final Map<String, String> dataFormat : dataFormats) {
if (verbose) {
+ String title = safeNull(dataFormat.get("title"));
String name = safeNull(dataFormat.get("name"));
String label = safeNull(dataFormat.get("label"));
String maven = "";
if (dataFormat.containsKey("groupId") && dataFormat.containsKey("artifactId") && dataFormat.containsKey("version")) {
maven = dataFormat.get("groupId") + "/" + dataFormat.get("artifactId") + "/" + dataFormat.get("version");
}
- String description = safeNull(dataFormat.get("description"));
- out.println(String.format(rowFormat, name, label, maven, description));
+ out.println(String.format(rowFormat, title, name, label, maven));
} else {
- String name = safeNull(dataFormat.get("name"));
- String label = safeNull(dataFormat.get("label"));
- String maven = "";
- if (dataFormat.containsKey("groupId") && dataFormat.containsKey("artifactId") && dataFormat.containsKey("version")) {
- maven = dataFormat.get("groupId") + "/" + dataFormat.get("artifactId") + "/" + dataFormat.get("version");
- }
- out.println(String.format(rowFormat, name, label, maven));
+ String title = safeNull(dataFormat.get("title"));
+ String description = safeNull(dataFormat.get("description"));
+ out.println(String.format(rowFormat, title, description));
}
}
@@ -97,6 +94,7 @@ public class CatalogDataFormatListCommand extends AbstractCamelCommand {
return null;
} else {
// some of the options is optional so we need to start from 1
+ int maxTitleLen = TITLE_COLUMN_LABEL.length();
int maxNameLen = NAME_COLUMN_LABEL.length();
int maxLabelLen = LABEL_COLUMN_LABEL.length();
int maxMavenLen = MAVEN_COLUMN_LABEL.length();
@@ -105,6 +103,10 @@ public class CatalogDataFormatListCommand extends AbstractCamelCommand {
for (final Map<String, String> dataFormat : dataFormats) {
// grab the information and compute max len
+ String title = dataFormat.get("title");
+ if (title != null) {
+ maxTitleLen = Math.max(maxTitleLen, title.length());
+ }
String name = dataFormat.get("name");
if (name != null) {
maxNameLen = Math.max(maxNameLen, name.length());
@@ -123,7 +125,8 @@ public class CatalogDataFormatListCommand extends AbstractCamelCommand {
}
}
- final Map<String, Integer> retval = new Hashtable<String, Integer>(4);
+ final Map<String, Integer> retval = new Hashtable<String, Integer>();
+ retval.put(TITLE_COLUMN_LABEL, maxTitleLen);
retval.put(NAME_COLUMN_LABEL, maxNameLen);
retval.put(LABEL_COLUMN_LABEL, maxLabelLen);
retval.put(MAVEN_COLUMN_LABEL, maxMavenLen);
@@ -148,35 +151,29 @@ public class CatalogDataFormatListCommand extends AbstractCamelCommand {
columnWidthIncrement = DEFAULT_COLUMN_WIDTH_INCREMENT;
if (verbose) {
+ int titleLen = Math.min(columnWidths.get(TITLE_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
int nameLen = Math.min(columnWidths.get(NAME_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
int labelLen = Math.min(columnWidths.get(LABEL_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
int mavenLen = Math.min(columnWidths.get(MAVEN_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
- int descriptionLen = Math.min(columnWidths.get(DESCRIPTION_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
+ titleLen = Math.max(MIN_COLUMN_WIDTH, titleLen);
nameLen = Math.max(MIN_COLUMN_WIDTH, nameLen);
labelLen = Math.max(MIN_COLUMN_WIDTH, labelLen);
mavenLen = Math.max(MIN_COLUMN_WIDTH, mavenLen);
- descriptionLen = Math.max(MIN_COLUMN_WIDTH, descriptionLen);
final StringBuilder retval = new StringBuilder(DEFAULT_FORMAT_BUFFER_LENGTH);
+ retval.append(fieldPreamble).append("%-").append(titleLen).append('.').append(titleLen).append('s').append(fieldPostamble).append(' ');
retval.append(fieldPreamble).append("%-").append(nameLen).append('.').append(nameLen).append('s').append(fieldPostamble).append(' ');
retval.append(fieldPreamble).append("%-").append(labelLen).append('.').append(labelLen).append('s').append(fieldPostamble).append(' ');
retval.append(fieldPreamble).append("%-").append(mavenLen).append('.').append(mavenLen).append('s').append(fieldPostamble).append(' ');
- retval.append(fieldPreamble).append("%-").append(descriptionLen).append('.').append(descriptionLen).append('s').append(fieldPostamble).append(' ');
return retval.toString();
} else {
- int nameLen = Math.min(columnWidths.get(NAME_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
- int labelLen = Math.min(columnWidths.get(LABEL_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
- int mavenLen = Math.min(columnWidths.get(MAVEN_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
-
- nameLen = Math.max(MIN_COLUMN_WIDTH, nameLen);
- labelLen = Math.max(MIN_COLUMN_WIDTH, labelLen);
- mavenLen = Math.max(MIN_COLUMN_WIDTH, mavenLen);
+ int titleLen = Math.min(columnWidths.get(TITLE_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
+ int descriptionLen = Math.min(columnWidths.get(DESCRIPTION_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
final StringBuilder retval = new StringBuilder(DEFAULT_FORMAT_BUFFER_LENGTH);
- retval.append(fieldPreamble).append("%-").append(nameLen).append('.').append(nameLen).append('s').append(fieldPostamble).append(' ');
- retval.append(fieldPreamble).append("%-").append(labelLen).append('.').append(labelLen).append('s').append(fieldPostamble).append(' ');
- retval.append(fieldPreamble).append("%-").append(mavenLen).append('.').append(mavenLen).append('s').append(fieldPostamble).append(' ');
+ retval.append(fieldPreamble).append("%-").append(titleLen).append('.').append(titleLen).append('s').append(fieldPostamble).append(' ');
+ retval.append(fieldPreamble).append("%-").append(descriptionLen).append('.').append(descriptionLen).append('s').append(fieldPostamble).append(' ');
return retval.toString();
}
}
http://git-wip-us.apache.org/repos/asf/camel/blob/2333474e/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogLanguageListCommand.java
----------------------------------------------------------------------
diff --git a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogLanguageListCommand.java b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogLanguageListCommand.java
index a4356c5..04ef0e2 100644
--- a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogLanguageListCommand.java
+++ b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogLanguageListCommand.java
@@ -26,6 +26,7 @@ import java.util.Map;
*/
public class CatalogLanguageListCommand extends AbstractCamelCommand {
+ private static final String TITLE_COLUMN_LABEL = "Title";
private static final String NAME_COLUMN_LABEL = "Name";
private static final String LABEL_COLUMN_LABEL = "Label";
private static final String MAVEN_COLUMN_LABEL = "Maven Coordinate";
@@ -62,30 +63,26 @@ public class CatalogLanguageListCommand extends AbstractCamelCommand {
final String rowFormat = buildFormatString(columnWidths, false);
if (verbose) {
- out.println(String.format(headerFormat, NAME_COLUMN_LABEL, LABEL_COLUMN_LABEL, MAVEN_COLUMN_LABEL, DESCRIPTION_COLUMN_LABEL));
- out.println(String.format(headerFormat, "----", "-----", "----------------", "-----------"));
+ out.println(String.format(headerFormat, TITLE_COLUMN_LABEL, NAME_COLUMN_LABEL, LABEL_COLUMN_LABEL, MAVEN_COLUMN_LABEL));
+ out.println(String.format(headerFormat, "-----", "----", "-----", "----------------"));
} else {
- out.println(String.format(headerFormat, NAME_COLUMN_LABEL, LABEL_COLUMN_LABEL, MAVEN_COLUMN_LABEL));
- out.println(String.format(headerFormat, "----", "-----", "----------------"));
+ out.println(String.format(headerFormat, TITLE_COLUMN_LABEL, DESCRIPTION_COLUMN_LABEL));
+ out.println(String.format(headerFormat, "-----", "-----------"));
}
for (final Map<String, String> language : languages) {
if (verbose) {
+ String title = safeNull(language.get("title"));
String name = safeNull(language.get("name"));
String label = safeNull(language.get("label"));
String maven = "";
if (language.containsKey("groupId") && language.containsKey("artifactId") && language.containsKey("version")) {
maven = language.get("groupId") + "/" + language.get("artifactId") + "/" + language.get("version");
}
- String description = safeNull(language.get("description"));
- out.println(String.format(rowFormat, name, label, maven, description));
+ out.println(String.format(rowFormat, title, name, label, maven));
} else {
- String name = safeNull(language.get("name"));
- String label = safeNull(language.get("label"));
- String maven = "";
- if (language.containsKey("groupId") && language.containsKey("artifactId") && language.containsKey("version")) {
- maven = language.get("groupId") + "/" + language.get("artifactId") + "/" + language.get("version");
- }
- out.println(String.format(rowFormat, name, label, maven));
+ String title = safeNull(language.get("title"));
+ String description = safeNull(language.get("description"));
+ out.println(String.format(rowFormat, title, description));
}
}
@@ -97,6 +94,7 @@ public class CatalogLanguageListCommand extends AbstractCamelCommand {
return null;
} else {
// some of the options is optional so we need to start from 1
+ int maxTitleLen = TITLE_COLUMN_LABEL.length();
int maxNameLen = NAME_COLUMN_LABEL.length();
int maxLabelLen = LABEL_COLUMN_LABEL.length();
int maxMavenLen = MAVEN_COLUMN_LABEL.length();
@@ -105,6 +103,10 @@ public class CatalogLanguageListCommand extends AbstractCamelCommand {
for (final Map<String, String> dataFormat : languages) {
// grab the information and compute max len
+ String title = dataFormat.get("title");
+ if (title != null) {
+ maxTitleLen = Math.max(maxTitleLen, title.length());
+ }
String name = dataFormat.get("name");
if (name != null) {
maxNameLen = Math.max(maxNameLen, name.length());
@@ -123,7 +125,8 @@ public class CatalogLanguageListCommand extends AbstractCamelCommand {
}
}
- final Map<String, Integer> retval = new Hashtable<String, Integer>(4);
+ final Map<String, Integer> retval = new Hashtable<String, Integer>();
+ retval.put(TITLE_COLUMN_LABEL, maxTitleLen);
retval.put(NAME_COLUMN_LABEL, maxNameLen);
retval.put(LABEL_COLUMN_LABEL, maxLabelLen);
retval.put(MAVEN_COLUMN_LABEL, maxMavenLen);
@@ -148,35 +151,35 @@ public class CatalogLanguageListCommand extends AbstractCamelCommand {
columnWidthIncrement = DEFAULT_COLUMN_WIDTH_INCREMENT;
if (verbose) {
+ int titleLen = Math.min(columnWidths.get(TITLE_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
int nameLen = Math.min(columnWidths.get(NAME_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
int labelLen = Math.min(columnWidths.get(LABEL_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
int mavenLen = Math.min(columnWidths.get(MAVEN_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
int descriptionLen = Math.min(columnWidths.get(DESCRIPTION_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
+ titleLen = Math.max(MIN_COLUMN_WIDTH, titleLen);
nameLen = Math.max(MIN_COLUMN_WIDTH, nameLen);
labelLen = Math.max(MIN_COLUMN_WIDTH, labelLen);
mavenLen = Math.max(MIN_COLUMN_WIDTH, mavenLen);
descriptionLen = Math.max(MIN_COLUMN_WIDTH, descriptionLen);
final StringBuilder retval = new StringBuilder(DEFAULT_FORMAT_BUFFER_LENGTH);
+ retval.append(fieldPreamble).append("%-").append(titleLen).append('.').append(titleLen).append('s').append(fieldPostamble).append(' ');
retval.append(fieldPreamble).append("%-").append(nameLen).append('.').append(nameLen).append('s').append(fieldPostamble).append(' ');
retval.append(fieldPreamble).append("%-").append(labelLen).append('.').append(labelLen).append('s').append(fieldPostamble).append(' ');
retval.append(fieldPreamble).append("%-").append(mavenLen).append('.').append(mavenLen).append('s').append(fieldPostamble).append(' ');
retval.append(fieldPreamble).append("%-").append(descriptionLen).append('.').append(descriptionLen).append('s').append(fieldPostamble).append(' ');
return retval.toString();
} else {
- int nameLen = Math.min(columnWidths.get(NAME_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
- int labelLen = Math.min(columnWidths.get(LABEL_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
- int mavenLen = Math.min(columnWidths.get(MAVEN_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
+ int titleLen = Math.min(columnWidths.get(TITLE_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
+ int descriptionLen = Math.min(columnWidths.get(DESCRIPTION_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
- nameLen = Math.max(MIN_COLUMN_WIDTH, nameLen);
- labelLen = Math.max(MIN_COLUMN_WIDTH, labelLen);
- mavenLen = Math.max(MIN_COLUMN_WIDTH, mavenLen);
+ titleLen = Math.max(MIN_COLUMN_WIDTH, titleLen);
+ descriptionLen = Math.max(MIN_COLUMN_WIDTH, descriptionLen);
final StringBuilder retval = new StringBuilder(DEFAULT_FORMAT_BUFFER_LENGTH);
- retval.append(fieldPreamble).append("%-").append(nameLen).append('.').append(nameLen).append('s').append(fieldPostamble).append(' ');
- retval.append(fieldPreamble).append("%-").append(labelLen).append('.').append(labelLen).append('s').append(fieldPostamble).append(' ');
- retval.append(fieldPreamble).append("%-").append(mavenLen).append('.').append(mavenLen).append('s').append(fieldPostamble).append(' ');
+ retval.append(fieldPreamble).append("%-").append(titleLen).append('.').append(titleLen).append('s').append(fieldPostamble).append(' ');
+ retval.append(fieldPreamble).append("%-").append(descriptionLen).append('.').append(descriptionLen).append('s').append(fieldPostamble).append(' ');
return retval.toString();
}
}