/** The Sone core. */
private final Core core;
+ /** Whether this command needs write access. */
+ private final boolean writeAccess;
+
/**
* Creates a new abstract Sone FCP command.
*
* The Sone core
*/
protected AbstractSoneCommand(Core core) {
+ this(core, false);
+ }
+
+ /**
+ * Creates a new abstract Sone FCP command.
+ *
+ * @param core
+ * The Sone core
+ * @param writeAccess
+ * {@code true} if this command requires write access,
+ * {@code false} otherwise
+ */
+ protected AbstractSoneCommand(Core core, boolean writeAccess) {
this.core = core;
+ this.writeAccess = writeAccess;
}
//
return core;
}
+ /**
+ * Returns whether this command requires write access.
+ *
+ * @return {@code true} if this command require write access, {@code false}
+ * otherwise
+ */
+ public boolean requiresWriteAccess() {
+ return writeAccess;
+ }
+
//
// PROTECTED METHODS
//
* @param parameterName
* The name under which the Sone ID is stored in the simple field
* set
+ * @param localOnly
+ * {@code true} to only return local Sones, {@code false} to
+ * return any Sones
* @return The Sone
* @throws FcpException
* if there is no Sone ID stored under the given parameter name,
* or if the Sone ID is invalid
*/
- protected Sone getSone(SimpleFieldSet simpleFieldSet, String parameterName) throws FcpException {
+ protected Sone getSone(SimpleFieldSet simpleFieldSet, String parameterName, boolean localOnly) throws FcpException {
try {
String soneId = simpleFieldSet.getString(parameterName);
- Sone sone = core.getSone(soneId, false);
+ Sone sone = localOnly ? core.getLocalSone(soneId, false) : core.getSone(soneId, false);
if (sone == null) {
throw new FcpException("Could not load Sone from “" + soneId + "”.");
}
}
/**
+ * Returns a reply whose ID is a parameter in the given simple field set.
+ *
+ * @param simpleFieldSet
+ * The simple field set containing the ID of the reply
+ * @param parameterName
+ * The name under which the reply ID is stored in the simple
+ * field set
+ * @return The reply
+ * @throws FcpException
+ * if there is no reply ID stored under the given parameter
+ * name, or if the reply ID is invalid
+ */
+ protected Reply getReply(SimpleFieldSet simpleFieldSet, String parameterName) throws FcpException {
+ try {
+ String replyId = simpleFieldSet.getString(parameterName);
+ Reply reply = core.getReply(replyId, false);
+ if (reply == null) {
+ throw new FcpException("Could not load reply from “" + replyId + "”.");
+ }
+ return reply;
+ } catch (FSParseException fspe1) {
+ throw new FcpException("Could not reply ID from “" + parameterName + "”.", fspe1);
+ }
+ }
+
+ /**
* Creates a simple field set from the given collection of Sones.
*
* @param sones
}
postBuilder.put(prefix + "Time", post.getTime());
postBuilder.put(prefix + "Text", post.getText());
+ postBuilder.put(encodeLikes(core.getLikes(post), prefix + "Likes."));
if (includeReplies) {
List<Reply> replies = core.getReplies(post);
return replyBuilder.get();
}
+ /**
+ * Creates a simple field set from the given collection of Sones that like
+ * an element.
+ *
+ * @param likes
+ * The liking Sones
+ * @param prefix
+ * The prefix for the field names (may be empty but not
+ * {@code null})
+ * @return The simple field set containing the likes
+ */
+ protected SimpleFieldSet encodeLikes(Collection<? extends Sone> likes, String prefix) {
+ SimpleFieldSetBuilder likesBuilder = new SimpleFieldSetBuilder();
+
+ int likeIndex = 0;
+ likesBuilder.put(prefix + "Count", likes.size());
+ for (Sone sone : likes) {
+ String sonePrefix = prefix + likeIndex++ + ".";
+ likesBuilder.put(sonePrefix + "ID", sone.getId());
+ }
+
+ return likesBuilder.get();
+ }
+
}