You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streams.apache.org by sb...@apache.org on 2014/11/16 22:22:58 UTC
[2/2] incubator-streams git commit: Added code comments
Added code comments
Project: http://git-wip-us.apache.org/repos/asf/incubator-streams/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-streams/commit/b5cb7eb6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-streams/tree/b5cb7eb6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-streams/diff/b5cb7eb6
Branch: refs/heads/STREAMS-68,218
Commit: b5cb7eb693be2fd3621c1b62c08f5548dee30dee
Parents: 3b41355
Author: Steve Blackmon <sb...@w2odigital.com>
Authored: Sun Nov 16 15:04:49 2014 -0600
Committer: Steve Blackmon <sb...@w2odigital.com>
Committed: Sun Nov 16 15:21:28 2014 -0600
----------------------------------------------------------------------
.../converter/ActivityConverterProcessor.java | 13 +++++++++++++
.../BaseActivityConverterResolver.java | 7 +++++--
.../converter/BaseDocumentClassifier.java | 6 +++++-
.../BaseObjectNodeActivityConverter.java | 6 +++++-
.../converter/BaseStringActivityConverter.java | 6 +++++-
.../converter/TypeConverterProcessor.java | 2 +-
.../streams/converter/TypeConverterUtil.java | 3 ++-
.../test/ActivityConverterProcessorTest.java | 20 ++------------------
.../test/TypeConverterProcessorTest.java | 3 ++-
.../serializer/DatasiftConverterResolver.java | 7 +------
.../serializer/DatasiftEventClassifier.java | 3 +--
.../datasift/util/StreamsDatasiftMapper.java | 3 +--
.../serializer/DatasiftEventClassifierTest.java | 5 +++--
.../conversion/MoreoverConverterResolver.java | 2 +-
.../conversion/MoreoverDocumentClassifier.java | 2 +-
.../rss/provider/RssDocumentClassifier.java | 3 +--
.../rss/serializer/RssConverterResolver.java | 2 +-
.../conversion/SysomosConverterResolver.java | 3 +--
.../conversion/SysomosDocumentClassifier.java | 2 +-
.../serializer/StreamsTwitterMapper.java | 10 +---------
.../serializer/TwitterConverterResolver.java | 2 +-
.../serializer/TwitterDocumentClassifier.java | 2 +-
.../streams/data/ActivityConverterFactory.java | 8 +++-----
.../ActivityDeserializerException.java | 7 ++-----
.../exceptions/ActivitySerializerException.java | 7 ++-----
.../jackson/StreamsDateTimeDeserializer.java | 10 ++++++++--
.../jackson/StreamsDateTimeSerializer.java | 5 ++---
.../streams/jackson/StreamsJacksonMapper.java | 4 +++-
.../streams/jackson/StreamsJacksonModule.java | 3 ++-
29 files changed, 77 insertions(+), 79 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-components/streams-converters/src/main/java/org/apache/streams/converter/ActivityConverterProcessor.java
----------------------------------------------------------------------
diff --git a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/ActivityConverterProcessor.java b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/ActivityConverterProcessor.java
index 521c906..a293dea 100644
--- a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/ActivityConverterProcessor.java
+++ b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/ActivityConverterProcessor.java
@@ -32,6 +32,19 @@ import org.slf4j.LoggerFactory;
import java.util.List;
/**
+ * ActivityConverterProcessor is a utility processor for converting any datum document
+ * to an Activity.
+ *
+ * By default it will handle string json and objectnode representation of existing Activities.
+ *
+ * Implementations can add DocumentClassifiers and ActivityConverterResolvers to the processor
+ * to ensure additional ActivityConverters will be resolved and applied.
+ *
+ * A DocumentClassifier's reponsibility is to recognize document formats and label them, using
+ * a jackson-compatible POJO class.
+ *
+ * An ActivityConverterResolver's reponsibility is to identify ActivityConverter implementations
+ * capable of converting a raw document associated with that POJO class into an activity.
*
*/
public class ActivityConverterProcessor extends TypeConverterProcessor {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseActivityConverterResolver.java
----------------------------------------------------------------------
diff --git a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseActivityConverterResolver.java b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseActivityConverterResolver.java
index 3347d25..30bb050 100644
--- a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseActivityConverterResolver.java
+++ b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseActivityConverterResolver.java
@@ -1,12 +1,15 @@
package org.apache.streams.converter;
import com.fasterxml.jackson.databind.node.ObjectNode;
-import org.apache.streams.data.ActivityConverter;
import org.apache.streams.data.ActivityConverterResolver;
import org.apache.streams.exceptions.ActivitySerializerException;
/**
- * Created by sblackmon on 11/12/14.
+ * BaseActivityConverterResolver is included by default in all
+ * @see {@link org.apache.streams.converter.ActivityConverterProcessor}
+ *
+ * Ensures generic String and ObjectNode documents can be converted to Activity
+ *
*/
public class BaseActivityConverterResolver implements ActivityConverterResolver {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseDocumentClassifier.java
----------------------------------------------------------------------
diff --git a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseDocumentClassifier.java b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseDocumentClassifier.java
index 3f92f5f..7733415 100644
--- a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseDocumentClassifier.java
+++ b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseDocumentClassifier.java
@@ -11,7 +11,11 @@ import org.apache.streams.pojo.json.Activity;
import java.io.IOException;
/**
- * Created by sblackmon on 11/12/14.
+ * BaseDocumentClassifier is included by default in all
+ * @see {@link org.apache.streams.converter.ActivityConverterProcessor}
+ *
+ * Ensures generic String and ObjectNode documents can be converted to Activity
+ *
*/
public class BaseDocumentClassifier implements DocumentClassifier {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseObjectNodeActivityConverter.java
----------------------------------------------------------------------
diff --git a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseObjectNodeActivityConverter.java b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseObjectNodeActivityConverter.java
index a4d0ea4..5c90fbc 100644
--- a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseObjectNodeActivityConverter.java
+++ b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseObjectNodeActivityConverter.java
@@ -11,7 +11,11 @@ import org.apache.streams.pojo.json.Activity;
import java.util.List;
/**
- * Created by sblackmon on 11/13/14.
+ * BaseObjectNodeActivityConverter is included by default in all
+ * @see {@link org.apache.streams.converter.ActivityConverterProcessor}
+ *
+ * Ensures generic ObjectNode representation of an Activity can be converted to Activity
+ *
*/
public class BaseObjectNodeActivityConverter implements ActivityConverter<ObjectNode> {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseStringActivityConverter.java
----------------------------------------------------------------------
diff --git a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseStringActivityConverter.java b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseStringActivityConverter.java
index ea0c108..c742532 100644
--- a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseStringActivityConverter.java
+++ b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/BaseStringActivityConverter.java
@@ -11,7 +11,11 @@ import org.apache.streams.pojo.json.Activity;
import java.util.List;
/**
- * Created by sblackmon on 11/13/14.
+ * BaseObjectNodeActivityConverter is included by default in all
+ * @see {@link org.apache.streams.converter.ActivityConverterProcessor}
+ *
+ * Ensures generic String Json representation of an Activity can be converted to Activity
+ *
*/
public class BaseStringActivityConverter implements ActivityConverter<String> {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-components/streams-converters/src/main/java/org/apache/streams/converter/TypeConverterProcessor.java
----------------------------------------------------------------------
diff --git a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/TypeConverterProcessor.java b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/TypeConverterProcessor.java
index 5ff5567..4b71b49 100644
--- a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/TypeConverterProcessor.java
+++ b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/TypeConverterProcessor.java
@@ -30,7 +30,7 @@ import java.io.Serializable;
import java.util.List;
/**
- *
+ * TypeConverterProcessor converts between String json and jackson-compatible POJO objects
*/
public class TypeConverterProcessor implements StreamsProcessor, Serializable {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-components/streams-converters/src/main/java/org/apache/streams/converter/TypeConverterUtil.java
----------------------------------------------------------------------
diff --git a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/TypeConverterUtil.java b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/TypeConverterUtil.java
index 8a39ac5..2ff463b 100644
--- a/streams-components/streams-converters/src/main/java/org/apache/streams/converter/TypeConverterUtil.java
+++ b/streams-components/streams-converters/src/main/java/org/apache/streams/converter/TypeConverterUtil.java
@@ -9,7 +9,8 @@ import org.slf4j.LoggerFactory;
import java.io.IOException;
/**
- * Created by sblackmon on 11/13/14.
+ * TypeConverterUtil supports TypeConverterProcessor in converting between String json and
+ * jackson-compatible POJO objects
*/
public class TypeConverterUtil {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-components/streams-converters/src/test/java/org/apache/streams/jackson/test/ActivityConverterProcessorTest.java
----------------------------------------------------------------------
diff --git a/streams-components/streams-converters/src/test/java/org/apache/streams/jackson/test/ActivityConverterProcessorTest.java b/streams-components/streams-converters/src/test/java/org/apache/streams/jackson/test/ActivityConverterProcessorTest.java
index 6d626b2..09f3295 100644
--- a/streams-components/streams-converters/src/test/java/org/apache/streams/jackson/test/ActivityConverterProcessorTest.java
+++ b/streams-components/streams-converters/src/test/java/org/apache/streams/jackson/test/ActivityConverterProcessorTest.java
@@ -33,7 +33,8 @@ import java.util.List;
import static junit.framework.Assert.*;
/**
- *
+ * Test for
+ * @see {@link org.apache.streams.converter.ActivityConverterProcessor}
*/
public class ActivityConverterProcessorTest {
@@ -82,21 +83,4 @@ public class ActivityConverterProcessorTest {
assertTrue(((Activity)resultDatum.getDocument()).getVerb().equals("share"));
}
-// @Test
-// public void testTypeConverterObjectNodeToString() throws IOException {
-// final String ID = "1";
-// StreamsProcessor processor = new ActivitySerializerProcessor(ObjectNode.class, String.class, Lists.newArrayList(DATASIFT_FORMAT));
-// processor.prepare(null);
-// ObjectMapper mapper = StreamsJacksonMapper.getInstance(Lists.newArrayList(DATASIFT_FORMAT));
-// ObjectNode node = mapper.readValue(DATASIFT_JSON, ObjectNode.class);
-// StreamsDatum datum = new StreamsDatum(node, ID);
-// List<StreamsDatum> result = processor.process(datum);
-// assertNotNull(result);
-// assertEquals(1, result.size());
-// StreamsDatum resultDatum = result.get(0);
-// assertNotNull(resultDatum);
-// assertNotNull(resultDatum.getDocument());
-// assertTrue(resultDatum.getDocument() instanceof String);
-// assertEquals(ID, resultDatum.getId());
-// }
}
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-components/streams-converters/src/test/java/org/apache/streams/jackson/test/TypeConverterProcessorTest.java
----------------------------------------------------------------------
diff --git a/streams-components/streams-converters/src/test/java/org/apache/streams/jackson/test/TypeConverterProcessorTest.java b/streams-components/streams-converters/src/test/java/org/apache/streams/jackson/test/TypeConverterProcessorTest.java
index 8a6c732..f830ea2 100644
--- a/streams-components/streams-converters/src/test/java/org/apache/streams/jackson/test/TypeConverterProcessorTest.java
+++ b/streams-components/streams-converters/src/test/java/org/apache/streams/jackson/test/TypeConverterProcessorTest.java
@@ -33,7 +33,8 @@ import java.util.List;
import static junit.framework.Assert.*;
/**
- *
+ * Test for
+ * @see {@link org.apache.streams.converter.TypeConverterProcessor}
*/
public class TypeConverterProcessorTest {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/serializer/DatasiftConverterResolver.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/serializer/DatasiftConverterResolver.java b/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/serializer/DatasiftConverterResolver.java
index 67cccd8..edeab34 100644
--- a/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/serializer/DatasiftConverterResolver.java
+++ b/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/serializer/DatasiftConverterResolver.java
@@ -18,17 +18,12 @@
package org.apache.streams.datasift.serializer;
-import com.google.common.base.Preconditions;
-import org.apache.streams.data.ActivityConverter;
import org.apache.streams.data.ActivityConverterResolver;
-import org.apache.streams.data.DocumentClassifier;
-import org.apache.streams.datasift.Datasift;
import org.apache.streams.datasift.instagram.Instagram;
-import org.apache.streams.datasift.interaction.Interaction;
import org.apache.streams.datasift.twitter.Twitter;
/**
- * Created by sblackmon on 11/6/14.
+ * Ensures datasift documents can be converted to Activity
*/
public class DatasiftConverterResolver implements ActivityConverterResolver {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/serializer/DatasiftEventClassifier.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/serializer/DatasiftEventClassifier.java b/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/serializer/DatasiftEventClassifier.java
index b258095..226c3f6 100644
--- a/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/serializer/DatasiftEventClassifier.java
+++ b/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/serializer/DatasiftEventClassifier.java
@@ -19,7 +19,6 @@
package org.apache.streams.datasift.serializer;
import com.google.common.base.Preconditions;
-import org.apache.streams.data.ActivityConverter;
import org.apache.streams.data.DocumentClassifier;
import org.apache.streams.datasift.Datasift;
import org.apache.streams.datasift.instagram.Instagram;
@@ -27,7 +26,7 @@ import org.apache.streams.datasift.interaction.Interaction;
import org.apache.streams.datasift.twitter.Twitter;
/**
- * Created by sblackmon on 11/6/14.
+ * Ensures datasift documents can be converted to Activity
*/
public class DatasiftEventClassifier implements DocumentClassifier {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/util/StreamsDatasiftMapper.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/util/StreamsDatasiftMapper.java b/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/util/StreamsDatasiftMapper.java
index 93ab28b..f771eb1 100644
--- a/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/util/StreamsDatasiftMapper.java
+++ b/streams-contrib/streams-provider-datasift/src/main/java/org/apache/streams/datasift/util/StreamsDatasiftMapper.java
@@ -32,9 +32,8 @@ import org.joda.time.format.DateTimeFormatter;
import java.io.IOException;
/**
- * Created by sblackmon on 3/27/14.
- *
* Depracated: Use StreamsJacksonMapper instead
+ * TODO: find another place to hold DATASIFT_FORMAT and delete this class
*/
@Deprecated()
public class StreamsDatasiftMapper extends StreamsJacksonMapper {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-datasift/src/test/java17/org/apache/streams/datasift/serializer/DatasiftEventClassifierTest.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-datasift/src/test/java17/org/apache/streams/datasift/serializer/DatasiftEventClassifierTest.java b/streams-contrib/streams-provider-datasift/src/test/java17/org/apache/streams/datasift/serializer/DatasiftEventClassifierTest.java
index 48aaeef..06d9046 100644
--- a/streams-contrib/streams-provider-datasift/src/test/java17/org/apache/streams/datasift/serializer/DatasiftEventClassifierTest.java
+++ b/streams-contrib/streams-provider-datasift/src/test/java17/org/apache/streams/datasift/serializer/DatasiftEventClassifierTest.java
@@ -27,13 +27,14 @@ import org.apache.streams.datasift.instagram.Instagram;
import org.apache.streams.datasift.twitter.Twitter;
import org.apache.streams.datasift.util.StreamsDatasiftMapper;
import org.apache.streams.jackson.StreamsJacksonMapper;
-import org.apache.streams.pojo.json.Activity;
import org.junit.Test;
import java.util.Scanner;
/**
- * Created by sblackmon on 12/13/13.
+ * Test for
+ * @see {@link org.apache.streams.datasift.serializer.DatasiftEventClassifier}
+ *
*/
public class DatasiftEventClassifierTest {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-moreover/src/main/java/org/apache/streams/data/moreover/conversion/MoreoverConverterResolver.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-moreover/src/main/java/org/apache/streams/data/moreover/conversion/MoreoverConverterResolver.java b/streams-contrib/streams-provider-moreover/src/main/java/org/apache/streams/data/moreover/conversion/MoreoverConverterResolver.java
index 64d7651..5c038ac 100644
--- a/streams-contrib/streams-provider-moreover/src/main/java/org/apache/streams/data/moreover/conversion/MoreoverConverterResolver.java
+++ b/streams-contrib/streams-provider-moreover/src/main/java/org/apache/streams/data/moreover/conversion/MoreoverConverterResolver.java
@@ -6,7 +6,7 @@ import org.apache.streams.data.ActivityConverterResolver;
import org.apache.streams.exceptions.ActivitySerializerException;
/**
- * Created by sblackmon on 11/13/14.
+ * Ensures moreover documents can be converted to Activity
*/
public class MoreoverConverterResolver implements ActivityConverterResolver {
@Override
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-moreover/src/main/java/org/apache/streams/data/moreover/conversion/MoreoverDocumentClassifier.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-moreover/src/main/java/org/apache/streams/data/moreover/conversion/MoreoverDocumentClassifier.java b/streams-contrib/streams-provider-moreover/src/main/java/org/apache/streams/data/moreover/conversion/MoreoverDocumentClassifier.java
index b65d8db..88ca5db 100644
--- a/streams-contrib/streams-provider-moreover/src/main/java/org/apache/streams/data/moreover/conversion/MoreoverDocumentClassifier.java
+++ b/streams-contrib/streams-provider-moreover/src/main/java/org/apache/streams/data/moreover/conversion/MoreoverDocumentClassifier.java
@@ -6,7 +6,7 @@ import com.moreover.api.Article;
import org.apache.streams.data.DocumentClassifier;
/**
- * Created by sblackmon on 11/13/14.
+ * Ensures moreover documents can be converted to Activity
*/
public class MoreoverDocumentClassifier implements DocumentClassifier {
@Override
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-rss/src/main/java/org/apache/streams/rss/provider/RssDocumentClassifier.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-rss/src/main/java/org/apache/streams/rss/provider/RssDocumentClassifier.java b/streams-contrib/streams-provider-rss/src/main/java/org/apache/streams/rss/provider/RssDocumentClassifier.java
index 1477c21..1e19eb4 100644
--- a/streams-contrib/streams-provider-rss/src/main/java/org/apache/streams/rss/provider/RssDocumentClassifier.java
+++ b/streams-contrib/streams-provider-rss/src/main/java/org/apache/streams/rss/provider/RssDocumentClassifier.java
@@ -18,12 +18,11 @@
package org.apache.streams.rss.provider;
-import com.fasterxml.jackson.databind.node.ObjectNode;
import com.sun.syndication.feed.synd.SyndEntry;
import org.apache.streams.data.DocumentClassifier;
/**
- * Created by sblackmon on 12/13/13.
+ * Ensures rss documents can be converted to Activity
*/
public class RssDocumentClassifier implements DocumentClassifier {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-rss/src/main/java/org/apache/streams/rss/serializer/RssConverterResolver.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-rss/src/main/java/org/apache/streams/rss/serializer/RssConverterResolver.java b/streams-contrib/streams-provider-rss/src/main/java/org/apache/streams/rss/serializer/RssConverterResolver.java
index e3e26dc..489ffec 100644
--- a/streams-contrib/streams-provider-rss/src/main/java/org/apache/streams/rss/serializer/RssConverterResolver.java
+++ b/streams-contrib/streams-provider-rss/src/main/java/org/apache/streams/rss/serializer/RssConverterResolver.java
@@ -5,7 +5,7 @@ import org.apache.streams.data.ActivityConverterResolver;
import org.apache.streams.exceptions.ActivitySerializerException;
/**
- * Created by sblackmon on 11/13/14.
+ * Ensures rss documents can be converted to Activity
*/
public class RssConverterResolver implements ActivityConverterResolver {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-sysomos/src/main/java/org/apache/streams/sysomos/conversion/SysomosConverterResolver.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-sysomos/src/main/java/org/apache/streams/sysomos/conversion/SysomosConverterResolver.java b/streams-contrib/streams-provider-sysomos/src/main/java/org/apache/streams/sysomos/conversion/SysomosConverterResolver.java
index 9eb613a..733c4c1 100644
--- a/streams-contrib/streams-provider-sysomos/src/main/java/org/apache/streams/sysomos/conversion/SysomosConverterResolver.java
+++ b/streams-contrib/streams-provider-sysomos/src/main/java/org/apache/streams/sysomos/conversion/SysomosConverterResolver.java
@@ -2,11 +2,10 @@ package org.apache.streams.sysomos.conversion;
import com.sysomos.xml.BeatApi;
import org.apache.streams.data.ActivityConverterResolver;
-import org.apache.streams.data.DocumentClassifier;
import org.apache.streams.exceptions.ActivitySerializerException;
/**
- * Created by sblackmon on 11/13/14.
+ * Ensures sysomos documents can be converted to Activity
*/
public class SysomosConverterResolver implements ActivityConverterResolver {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-sysomos/src/main/java/org/apache/streams/sysomos/conversion/SysomosDocumentClassifier.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-sysomos/src/main/java/org/apache/streams/sysomos/conversion/SysomosDocumentClassifier.java b/streams-contrib/streams-provider-sysomos/src/main/java/org/apache/streams/sysomos/conversion/SysomosDocumentClassifier.java
index d5314df..0db5624 100644
--- a/streams-contrib/streams-provider-sysomos/src/main/java/org/apache/streams/sysomos/conversion/SysomosDocumentClassifier.java
+++ b/streams-contrib/streams-provider-sysomos/src/main/java/org/apache/streams/sysomos/conversion/SysomosDocumentClassifier.java
@@ -4,7 +4,7 @@ import com.sysomos.xml.BeatApi;
import org.apache.streams.data.DocumentClassifier;
/**
- * Created by sblackmon on 11/13/14.
+ * Ensures sysomos documents can be converted to Activity
*/
public class SysomosDocumentClassifier implements DocumentClassifier {
@Override
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/StreamsTwitterMapper.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/StreamsTwitterMapper.java b/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/StreamsTwitterMapper.java
index 395bd95..3b5f763 100644
--- a/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/StreamsTwitterMapper.java
+++ b/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/StreamsTwitterMapper.java
@@ -18,20 +18,13 @@
package org.apache.streams.twitter.serializer;
-import com.fasterxml.jackson.annotation.JsonAutoDetect;
-import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
-import com.fasterxml.jackson.databind.DeserializationFeature;
-import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
import com.fasterxml.jackson.databind.module.SimpleModule;
import org.apache.streams.data.util.RFC3339Utils;
-import org.apache.streams.jackson.StreamsDateTimeDeserializer;
-import org.apache.streams.jackson.StreamsDateTimeSerializer;
import org.apache.streams.jackson.StreamsJacksonMapper;
-import org.apache.streams.jackson.StreamsJacksonModule;
import org.joda.time.DateTime;
import org.joda.time.format.DateTimeFormat;
import org.joda.time.format.DateTimeFormatter;
@@ -39,9 +32,8 @@ import org.joda.time.format.DateTimeFormatter;
import java.io.IOException;
/**
- * Created by sblackmon on 3/27/14.
- *
* Deprecated: Use StreamsJacksonMapper
+ * TODO: find another place to put TWITTER_FORMAT and delete this class
*/
@Deprecated
public class StreamsTwitterMapper extends StreamsJacksonMapper {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/TwitterConverterResolver.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/TwitterConverterResolver.java b/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/TwitterConverterResolver.java
index 5a58e42..e1f5b5f 100644
--- a/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/TwitterConverterResolver.java
+++ b/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/TwitterConverterResolver.java
@@ -23,7 +23,7 @@ import org.apache.streams.exceptions.ActivitySerializerException;
import org.apache.streams.twitter.pojo.*;
/**
- * Created by sblackmon on 12/13/13.
+ * Ensures twitter documents can be converted to Activity
*/
public class TwitterConverterResolver implements ActivityConverterResolver {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/TwitterDocumentClassifier.java
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/TwitterDocumentClassifier.java b/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/TwitterDocumentClassifier.java
index 1719491..3b61b3b 100644
--- a/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/TwitterDocumentClassifier.java
+++ b/streams-contrib/streams-provider-twitter/src/main/java/org/apache/streams/twitter/serializer/TwitterDocumentClassifier.java
@@ -30,7 +30,7 @@ import org.apache.streams.twitter.pojo.*;
import java.io.IOException;
/**
- * Created by sblackmon on 12/13/13.
+ * Ensures twitter documents can be converted to Activity
*/
public class TwitterDocumentClassifier implements DocumentClassifier {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-pojo/src/main/java/org/apache/streams/data/ActivityConverterFactory.java
----------------------------------------------------------------------
diff --git a/streams-pojo/src/main/java/org/apache/streams/data/ActivityConverterFactory.java b/streams-pojo/src/main/java/org/apache/streams/data/ActivityConverterFactory.java
index 3f058ed..843704a 100644
--- a/streams-pojo/src/main/java/org/apache/streams/data/ActivityConverterFactory.java
+++ b/streams-pojo/src/main/java/org/apache/streams/data/ActivityConverterFactory.java
@@ -1,14 +1,12 @@
package org.apache.streams.data;
-import org.apache.streams.data.ActivityConverter;
-
/**
- * Created by sblackmon on 11/13/14.
+ * Instantiates a class that con convert a type of document to an activity
*/
-public class ActivityConverterFactory {
+ public class ActivityConverterFactory {
/**
- * Identifies a class that con convert this document to an activity
+ * Instantiates a class that con convert this type of document to an activity
*
* @param converterClass known class of the converter
* @return an appropriate ActivityConverter
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-pojo/src/main/java/org/apache/streams/exceptions/ActivityDeserializerException.java
----------------------------------------------------------------------
diff --git a/streams-pojo/src/main/java/org/apache/streams/exceptions/ActivityDeserializerException.java b/streams-pojo/src/main/java/org/apache/streams/exceptions/ActivityDeserializerException.java
index 70901d9..02f0b11 100644
--- a/streams-pojo/src/main/java/org/apache/streams/exceptions/ActivityDeserializerException.java
+++ b/streams-pojo/src/main/java/org/apache/streams/exceptions/ActivityDeserializerException.java
@@ -19,27 +19,24 @@
package org.apache.streams.exceptions;
/**
- * Created by sblackmon on 3/25/14.
+ * ActivityDeserializerException is a typed exception appropriate when an Activity
+ * cannot be converted to an appropriate alternative format.
*/
public class ActivityDeserializerException extends Exception {
public ActivityDeserializerException() {
- // TODO Auto-generated constructor stub
}
public ActivityDeserializerException(String message) {
super(message);
- // TODO Auto-generated constructor stub
}
public ActivityDeserializerException(Throwable cause) {
super(cause);
- // TODO Auto-generated constructor stub
}
public ActivityDeserializerException(String message, Throwable cause) {
super(message, cause);
- // TODO Auto-generated constructor stub
}
}
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-pojo/src/main/java/org/apache/streams/exceptions/ActivitySerializerException.java
----------------------------------------------------------------------
diff --git a/streams-pojo/src/main/java/org/apache/streams/exceptions/ActivitySerializerException.java b/streams-pojo/src/main/java/org/apache/streams/exceptions/ActivitySerializerException.java
index e58e2da..07c76b6 100644
--- a/streams-pojo/src/main/java/org/apache/streams/exceptions/ActivitySerializerException.java
+++ b/streams-pojo/src/main/java/org/apache/streams/exceptions/ActivitySerializerException.java
@@ -19,27 +19,24 @@
package org.apache.streams.exceptions;
/**
- * Created by sblackmon on 3/25/14.
+ * ActivitySerializerException is a typed exception appropriate when a valid Activity
+ * cannot be created from a given document.
*/
public class ActivitySerializerException extends Exception {
public ActivitySerializerException() {
- // TODO Auto-generated constructor stub
}
public ActivitySerializerException(String message) {
super(message);
- // TODO Auto-generated constructor stub
}
public ActivitySerializerException(Throwable cause) {
super(cause);
- // TODO Auto-generated constructor stub
}
public ActivitySerializerException(String message, Throwable cause) {
super(message, cause);
- // TODO Auto-generated constructor stub
}
}
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsDateTimeDeserializer.java
----------------------------------------------------------------------
diff --git a/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsDateTimeDeserializer.java b/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsDateTimeDeserializer.java
index 8f53954..639c5ad 100644
--- a/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsDateTimeDeserializer.java
+++ b/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsDateTimeDeserializer.java
@@ -29,12 +29,15 @@ import org.joda.time.format.DateTimeFormatter;
import java.io.IOException;
import java.io.Serializable;
-import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
/**
- * Created by sblackmon on 3/27/14.
+ * StreamsDateTimeDeserializer is a supporting class for
+ * @see {@link org.apache.streams.jackson.StreamsJacksonMapper}
+ *
+ * Converting date-time strings other than RFC3339 to joda DateTime objects requires
+ * additional formats to be provided when instantiating StreamsJacksonMapper.
*/
public class StreamsDateTimeDeserializer extends StdDeserializer<DateTime> implements Serializable {
@@ -50,6 +53,9 @@ public class StreamsDateTimeDeserializer extends StdDeserializer<DateTime> imple
formatters.add(DateTimeFormat.forPattern(format));
}
+ /**
+ * Applies each additional format in turn, until it can provide a non-null DateTime
+ */
@Override
public DateTime deserialize(JsonParser jpar, DeserializationContext context) throws IOException {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsDateTimeSerializer.java
----------------------------------------------------------------------
diff --git a/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsDateTimeSerializer.java b/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsDateTimeSerializer.java
index 1e9c895..fff314d 100644
--- a/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsDateTimeSerializer.java
+++ b/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsDateTimeSerializer.java
@@ -28,12 +28,11 @@ import java.io.IOException;
import java.io.Serializable;
/**
- * Created by sblackmon on 3/27/14.
+ * StreamsDateTimeSerializer is a supporting class for
+ * @see {@link org.apache.streams.jackson.StreamsJacksonMapper}
*/
public class StreamsDateTimeSerializer extends StdSerializer<DateTime> implements Serializable {
-
-
protected StreamsDateTimeSerializer(Class<DateTime> dateTimeClass) {
super(dateTimeClass);
}
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsJacksonMapper.java
----------------------------------------------------------------------
diff --git a/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsJacksonMapper.java b/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsJacksonMapper.java
index c85de84..9738fe4 100644
--- a/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsJacksonMapper.java
+++ b/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsJacksonMapper.java
@@ -29,7 +29,9 @@ import com.google.common.collect.Lists;
import java.util.List;
/**
- * Created by sblackmon on 3/27/14.
+ * StreamsJacksonMapper is the recommended interface to jackson for any streams component.
+ *
+ * Date-time formats that must be supported can be specified with constructor arguments.
*/
public class StreamsJacksonMapper extends ObjectMapper {
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/b5cb7eb6/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsJacksonModule.java
----------------------------------------------------------------------
diff --git a/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsJacksonModule.java b/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsJacksonModule.java
index 8b44b0f..d7e6c64 100644
--- a/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsJacksonModule.java
+++ b/streams-pojo/src/main/java/org/apache/streams/jackson/StreamsJacksonModule.java
@@ -25,7 +25,8 @@ import org.joda.time.Period;
import java.util.List;
/**
- * Created by sblackmon on 3/27/14.
+ * StreamsJacksonModule is a supporting class for
+ * @see {@link org.apache.streams.jackson.StreamsJacksonMapper}
*/
public class StreamsJacksonModule extends SimpleModule {