You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2015/01/22 17:56:33 UTC
[05/50] [abbrv] isis git commit: ISIS-970: completed the
ActionAnnotationFacetFactory,
with additional refactoring for DomainObjectFacetFactory
http://git-wip-us.apache.org/repos/asf/isis/blob/525c0c45/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItem.java
----------------------------------------------------------------------
diff --git a/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItem.java b/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItem.java
index ae41fa6..bd1b281 100644
--- a/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItem.java
+++ b/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItem.java
@@ -22,7 +22,6 @@ import java.math.BigDecimal;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Arrays;
-import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
@@ -38,27 +37,24 @@ import org.apache.isis.applib.DomainObjectContainer;
import org.apache.isis.applib.Identifier;
import org.apache.isis.applib.NonRecoverableException;
import org.apache.isis.applib.RecoverableException;
-import org.apache.isis.applib.annotation.ActionInteraction;
+import org.apache.isis.applib.annotation.Action;
import org.apache.isis.applib.annotation.ActionLayout;
-import org.apache.isis.applib.annotation.ActionSemantics;
-import org.apache.isis.applib.annotation.ActionSemantics.Of;
-import org.apache.isis.applib.annotation.AutoComplete;
-import org.apache.isis.applib.annotation.Bookmarkable;
+import org.apache.isis.applib.annotation.BookmarkPolicy;
import org.apache.isis.applib.annotation.Bulk;
-import org.apache.isis.applib.annotation.Bulk.AppliesTo;
-import org.apache.isis.applib.annotation.Bulk.InteractionContext.InvokedAs;
-import org.apache.isis.applib.annotation.CollectionInteraction;
+import org.apache.isis.applib.annotation.Collection;
import org.apache.isis.applib.annotation.CollectionLayout;
-import org.apache.isis.applib.annotation.Disabled;
-import org.apache.isis.applib.annotation.Hidden;
-import org.apache.isis.applib.annotation.MinLength;
-import org.apache.isis.applib.annotation.ObjectType;
-import org.apache.isis.applib.annotation.Optional;
+import org.apache.isis.applib.annotation.DomainObject;
+import org.apache.isis.applib.annotation.DomainObjectLayout;
+import org.apache.isis.applib.annotation.Editing;
+import org.apache.isis.applib.annotation.InvokeOn;
+import org.apache.isis.applib.annotation.InvokedOn;
+import org.apache.isis.applib.annotation.Optionality;
+import org.apache.isis.applib.annotation.Parameter;
import org.apache.isis.applib.annotation.ParameterLayout;
import org.apache.isis.applib.annotation.Programmatic;
-import org.apache.isis.applib.annotation.PropertyInteraction;
-import org.apache.isis.applib.annotation.RegEx;
-import org.apache.isis.applib.annotation.TypicalLength;
+import org.apache.isis.applib.annotation.Property;
+import org.apache.isis.applib.annotation.SemanticsOf;
+import org.apache.isis.applib.annotation.Where;
import org.apache.isis.applib.security.UserMemento;
import org.apache.isis.applib.services.eventbus.ActionInteractionEvent;
import org.apache.isis.applib.services.eventbus.EventBusService;
@@ -118,10 +114,15 @@ import com.google.common.collect.Ordering;
+ "WHERE ownedBy == :ownedBy && "
+ "description.indexOf(:description) >= 0")
})
-@ObjectType("TODO")
-@AutoComplete(repository=ToDoItems.class, action="autoComplete") // default unless overridden by autoCompleteNXxx() method
-//@Bounded - if there were a small number of instances only (overrides autoComplete functionality)
-@Bookmarkable
+@DomainObject(
+ autoCompleteRepository = ToDoItems.class, // for drop-downs, unless autoCompleteNXxx() is present
+ autoCompleteAction = "autoComplete",
+ // bounded = true, // for drop-downs if only a small number of instances only (overrides autoComplete)
+ objectType = "TODO"
+)
+@DomainObjectLayout(
+ bookmarking = BookmarkPolicy.AS_ROOT
+)
public class ToDoItem implements Categorized, Comparable<ToDoItem> {
//region > LOG
@@ -144,8 +145,7 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
if (dueBy != null) {
buf.append(" due by", dueBy);
}
- } catch(HiddenException ex) {
- // ignore
+ } catch(final HiddenException ignored) {
}
}
return buf.toString();
@@ -163,8 +163,9 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
private String description;
@javax.jdo.annotations.Column(allowsNull="false", length=100)
- @PropertyInteraction()
- @RegEx(validation = "\\w[@&:\\-\\,\\.\\+ \\w]*")
+ @Property(
+ regexPattern = "\\w[@&:\\-\\,\\.\\+ \\w]*"
+ )
public String getDescription() {
return description;
}
@@ -248,7 +249,7 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
// other
Other;
- public static List<Subcategory> listFor(Category category) {
+ public static List<Subcategory> listFor(final Category category) {
return category != null? category.subcategories(): Collections.<Subcategory>emptyList();
}
@@ -265,7 +266,7 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
return new Predicate<Subcategory>() {
@Override
- public boolean apply(Subcategory subcategory) {
+ public boolean apply(final Subcategory subcategory) {
return category.subcategories().contains(subcategory);
}
};
@@ -277,7 +278,10 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
private Category category;
@javax.jdo.annotations.Column(allowsNull="false")
- @Disabled(reason="Use action to update both category and subcategory")
+ @Property(
+ editing = Editing.DISABLED,
+ editingDisabledReason = "Use action to update both category and subcategory"
+ )
public Category getCategory() {
return category;
}
@@ -291,7 +295,10 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
private Subcategory subcategory;
@javax.jdo.annotations.Column(allowsNull="true")
- @Disabled(reason="Use action to update both category and subcategory")
+ @Property(
+ editing = Editing.DISABLED,
+ editingDisabledReason = "Use action to update both category and subcategory"
+ )
public Subcategory getSubcategory() {
return subcategory;
}
@@ -318,7 +325,9 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
private boolean complete;
- @Disabled
+ @Property(
+ editing = Editing.DISABLED
+ )
public boolean isComplete() {
return complete;
}
@@ -327,8 +336,10 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
this.complete = complete;
}
- @ActionInteraction(CompletedEvent.class)
- @Bulk
+ @Action(
+ interaction=CompletedEvent.class,
+ invokeOn = InvokeOn.OBJECT_AND_COLLECTION
+ )
public ToDoItem completed() {
setComplete(true);
@@ -346,21 +357,22 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
// if invoked as a regular action, return this object;
// otherwise (if invoked as bulk), return null (so go back to the list)
- return bulkInteractionContext.getInvokedAs() == InvokedAs.REGULAR? this: null;
+ return bulkInteractionContext.getInvokedOn() == InvokedOn.OBJECT? this: null;
}
// disable action dependent on state of object
public String disableCompleted() {
return isComplete() ? "Already completed" : null;
}
- @ActionInteraction(NoLongerCompletedEvent.class)
- @Bulk
+ @Action(
+ invokeOn = InvokeOn.OBJECT_AND_COLLECTION
+ )
public ToDoItem notYetCompleted() {
setComplete(false);
// if invoked as a regular action, return this object;
// otherwise (if invoked as bulk), return null (so go back to the list)
- return bulkInteractionContext.getInvokedAs() == InvokedAs.REGULAR? this: null;
+ return bulkInteractionContext.getInvokedOn() == InvokedOn.COLLECTION ? this: null;
}
// disable action dependent on state of object
public String disableNotYetCompleted() {
@@ -370,11 +382,13 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
//region > completeSlowly (property)
// ////////////////////////////////////////////////////////////////////////////////////////////////////////////////
- @Hidden
- public void completeSlowly(int millis) {
+ @Action(
+ hidden = Where.EVERYWHERE
+ )
+ public void completeSlowly(final int millis) {
try {
Thread.sleep(millis);
- } catch (InterruptedException e) {
+ } catch (final InterruptedException ignored) {
}
setComplete(true);
}
@@ -385,27 +399,32 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
@javax.jdo.annotations.Column(allowsNull="true", scale=2)
@javax.validation.constraints.Digits(integer=10, fraction=2)
- @Disabled(reason="Update using action")
+ @Property(
+ editing = Editing.DISABLED,
+ editingDisabledReason = "Update using action"
+ )
public BigDecimal getCost() {
return cost;
}
public void setCost(final BigDecimal cost) {
- this.cost = cost!=null?cost.setScale(2):null;
+ this.cost = cost!=null?cost.setScale(2, BigDecimal.ROUND_HALF_EVEN):null;
}
- @ActionSemantics(Of.IDEMPOTENT)
+ @Action(
+ semantics = SemanticsOf.IDEMPOTENT
+ )
public ToDoItem updateCost(
+ @Parameter(optional = Optionality.TRUE)
@ParameterLayout(named = "New cost")
@javax.validation.constraints.Digits(integer=10, fraction=2)
- @Optional
final BigDecimal cost) {
LOG.debug("%s: cost updated: %s -> %s", container.titleOf(this), getCost(), cost);
// just to simulate a long-running action
try {
Thread.sleep(3000);
- } catch (InterruptedException e) {
+ } catch (final InterruptedException ignored) {
}
setCost(cost);
@@ -444,7 +463,9 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
@javax.jdo.annotations.Column(name = "attachment_mimetype"),
@javax.jdo.annotations.Column(name = "attachment_bytes", jdbcType = "BLOB", sqlType = "BLOB")
})
- @Optional
+ @Property(
+ optional = Optionality.TRUE
+ )
public Blob getAttachment() {
return attachment;
}
@@ -461,7 +482,9 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
@javax.jdo.annotations.Column(name = "doc_mimetype"),
@javax.jdo.annotations.Column(name = "doc_chars", jdbcType = "CLOB", sqlType = "CLOB")
})
- @Optional
+ @Property(
+ optional = Optionality.TRUE
+ )
public Clob getDoc() {
return doc;
}
@@ -475,10 +498,8 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
public Long getVersionSequence() {
if(!(this instanceof javax.jdo.spi.PersistenceCapable)) {
return null;
- }
- javax.jdo.spi.PersistenceCapable persistenceCapable = (javax.jdo.spi.PersistenceCapable) this;
- final Long version = (Long) JDOHelper.getVersion(persistenceCapable);
- return version;
+ }
+ return (Long) JDOHelper.getVersion((javax.jdo.spi.PersistenceCapable) this);
}
// hide property (imperatively, based on state of object)
public boolean hideVersionSequence() {
@@ -491,8 +512,8 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
// overrides the natural ordering
public static class DependenciesComparator implements Comparator<ToDoItem> {
@Override
- public int compare(ToDoItem p, ToDoItem q) {
- Ordering<ToDoItem> byDescription = new Ordering<ToDoItem>() {
+ public int compare(final ToDoItem p, final ToDoItem q) {
+ final Ordering<ToDoItem> byDescription = new Ordering<ToDoItem>() {
public int compare(final ToDoItem p, final ToDoItem q) {
return Ordering.natural().nullsFirst().compare(p.getDescription(), q.getDescription());
}
@@ -506,10 +527,11 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
@javax.jdo.annotations.Persistent(table="ToDoItemDependencies")
@javax.jdo.annotations.Join(column="dependingId")
@javax.jdo.annotations.Element(column="dependentId")
+
private Set<ToDoItem> dependencies = new TreeSet<>();
//private SortedSet<ToDoItem> dependencies = new TreeSet<>(); // not compatible with neo4j (as of DN v3.2.3)
- @CollectionInteraction
+ @Collection()
@CollectionLayout(/*sortedBy = DependenciesComparator.class*/) // not compatible with neo4j (as of DN v3.2.3)
public Set<ToDoItem> getDependencies() {
return dependencies;
@@ -526,14 +548,18 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
getDependencies().remove(toDoItem);
}
- public ToDoItem add(final ToDoItem toDoItem) {
+ public ToDoItem add(
+ @ParameterLayout(typicalLength = 20)
+ final ToDoItem toDoItem) {
// By wrapping the call, Isis will detect that the collection is modified
// and it will automatically send CollectionInteractionEvents to the Event Bus.
// ToDoItemSubscriptions is a demo subscriber to this event
wrapperFactory.wrapSkipRules(this).addToDependencies(toDoItem);
return this;
}
- public List<ToDoItem> autoComplete0Add(final @MinLength(2) String search) {
+ public List<ToDoItem> autoComplete0Add(
+ @Parameter(minLength = 2)
+ final String search) {
final List<ToDoItem> list = toDoItems.autoComplete(search);
list.removeAll(getDependencies());
list.remove(this);
@@ -558,7 +584,7 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
}
public ToDoItem remove(
- @TypicalLength(20)
+ @ParameterLayout(typicalLength = 20)
final ToDoItem toDoItem) {
// By wrapping the call, Isis will detect that the collection is modified
// and it will automatically send a CollectionInteractionEvent to the Event Bus.
@@ -581,7 +607,7 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
return null;
}
// provide a drop-down
- public Collection<ToDoItem> choices0Remove() {
+ public java.util.Collection<ToDoItem> choices0Remove() {
return getDependencies();
}
//endregion
@@ -593,11 +619,19 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
// (a) has different semantics and (b) is in any case automatically ignored
// by the framework
public ToDoItem duplicate(
- final @RegEx(validation = "\\w[@&:\\-\\,\\.\\+ \\w]*") @ParameterLayout(named="Description") String description,
- final @ParameterLayout(named="Category") Category category,
- final @ParameterLayout(named="Subcategory") Subcategory subcategory,
- final @Optional @ParameterLayout(named="Due by") LocalDate dueBy,
- final @Optional @ParameterLayout(named="Cost") BigDecimal cost) {
+ @Parameter(regexPattern = "\\w[@&:\\-\\,\\.\\+ \\w]*" )
+ @ParameterLayout(named="Description")
+ final String description,
+ @ParameterLayout(named="Category")
+ final Category category,
+ @ParameterLayout(named="Subcategory")
+ final Subcategory subcategory,
+ @Parameter(optional = Optionality.TRUE)
+ @ParameterLayout(named="Due by")
+ final LocalDate dueBy,
+ @Parameter(optional = Optionality.TRUE)
+ @ParameterLayout(named="Cost")
+ final BigDecimal cost) {
return toDoItems.newToDo(description, category, subcategory, dueBy, cost);
}
public String default0Duplicate() {
@@ -625,8 +659,10 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
//endregion
//region > delete (action)
- @ActionInteraction(DeletedEvent.class)
- @Bulk
+ @Action(
+ interaction=DeletedEvent.class,
+ invokeOn = InvokeOn.OBJECT_AND_COLLECTION
+ )
public List<ToDoItem> delete() {
container.removeIfNotAlready(this);
@@ -639,21 +675,23 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
//endregion
//region > totalCost (property)
- @ActionSemantics(Of.SAFE)
- @Bulk(AppliesTo.BULK_ONLY)
+ @Action(
+ semantics = SemanticsOf.SAFE,
+ invokeOn = InvokeOn.COLLECTION_ONLY
+ )
public BigDecimal totalCost() {
BigDecimal total = (BigDecimal) scratchpad.get("runningTotal");
if(getCost() != null) {
total = total != null ? total.add(getCost()) : getCost();
scratchpad.put("runningTotal", total);
}
- return total.setScale(2);
+ return total.setScale(2, BigDecimal.ROUND_HALF_EVEN);
}
//endregion
//region > openSourceCodeOnGithub (action)
+ @Action(semantics = SemanticsOf.SAFE)
@ActionLayout(prototype = true)
- @ActionSemantics(Of.SAFE)
public URL openSourceCodeOnGithub() throws MalformedURLException {
return new URL("https://github.com/apache/isis/tree/master/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItem.java");
}
@@ -667,10 +705,11 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
NonRecoverableException;
}
+ @Action(semantics = SemanticsOf.SAFE)
@ActionLayout(prototype = true)
- @ActionSemantics(Of.SAFE)
public void demoException(
- final @ParameterLayout(named="Type") DemoExceptionType type) {
+ @ParameterLayout(named="Type")
+ final DemoExceptionType type) {
switch(type) {
case NonRecoverableException:
throw new NonRecoverableException("Demo throwing " + type.name());
@@ -695,30 +734,24 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
public void created() {
LOG.debug("lifecycle callback: created: " + this.toString());
}
-
public void loaded() {
LOG.debug("lifecycle callback: loaded: " + this.toString());
}
-
public void persisting() {
LOG.debug("lifecycle callback: persisting: " + this.toString());
}
-
public void persisted() {
LOG.debug("lifecycle callback: persisted: " + this.toString());
}
-
public void updating() {
LOG.debug("lifecycle callback: updating: " + this.toString());
}
public void updated() {
LOG.debug("lifecycle callback: updated: " + this.toString());
}
-
public void removing() {
LOG.debug("lifecycle callback: removing: " + this.toString());
}
-
public void removed() {
LOG.debug("lifecycle callback: removed: " + this.toString());
}
@@ -738,7 +771,7 @@ public class ToDoItem implements Categorized, Comparable<ToDoItem> {
/**
* Prevent user from modifying any other user's data.
*/
- public String disabled(Identifier.Type type){
+ public String disabled(final Identifier.Type identifierType){
final UserMemento currentUser = container.getUser();
final String currentUserName = currentUser.getName();
if(Objects.equal(getOwnedBy(), currentUserName)) { return null; }
http://git-wip-us.apache.org/repos/asf/isis/blob/525c0c45/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItemChangedPayloadFactory.java
----------------------------------------------------------------------
diff --git a/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItemChangedPayloadFactory.java b/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItemChangedPayloadFactory.java
index 2ecf5ab..32b2aa4 100644
--- a/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItemChangedPayloadFactory.java
+++ b/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItemChangedPayloadFactory.java
@@ -18,12 +18,12 @@
*/
package dom.todo;
-import org.apache.isis.applib.annotation.PublishedObject.ChangeKind;
-import org.apache.isis.applib.annotation.PublishedObject.PayloadFactory;
+import org.apache.isis.applib.annotation.PublishingChangeKind;
+import org.apache.isis.applib.annotation.PublishingPayloadFactoryForObject;
import org.apache.isis.applib.services.publish.EventPayload;
import org.apache.isis.applib.services.publish.EventPayloadForObjectChanged;
-public class ToDoItemChangedPayloadFactory implements PayloadFactory{
+public class ToDoItemChangedPayloadFactory implements PublishingPayloadFactoryForObject {
public static class ToDoItemPayload extends EventPayloadForObjectChanged<ToDoItem> {
@@ -41,7 +41,7 @@ public class ToDoItemChangedPayloadFactory implements PayloadFactory{
}
@Override
- public EventPayload payloadFor(Object changedObject, ChangeKind changeKind) {
+ public EventPayload payloadFor(final Object changedObject, final PublishingChangeKind publishingChangeKind) {
return new ToDoItemPayload((ToDoItem) changedObject);
}
http://git-wip-us.apache.org/repos/asf/isis/blob/525c0c45/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItemContributions.java
----------------------------------------------------------------------
diff --git a/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItemContributions.java b/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItemContributions.java
index fc6a9e0..369f743 100644
--- a/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItemContributions.java
+++ b/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItemContributions.java
@@ -30,17 +30,16 @@ import com.google.common.collect.Lists;
import com.google.common.collect.Ordering;
import org.joda.time.LocalDate;
import org.apache.isis.applib.AbstractFactoryAndRepository;
-import org.apache.isis.applib.annotation.ActionSemantics;
-import org.apache.isis.applib.annotation.ActionSemantics.Of;
-import org.apache.isis.applib.annotation.DescribedAs;
+import org.apache.isis.applib.annotation.Action;
+import org.apache.isis.applib.annotation.ActionLayout;
import org.apache.isis.applib.annotation.Disabled;
import org.apache.isis.applib.annotation.DomainService;
-import org.apache.isis.applib.annotation.Hidden;
import org.apache.isis.applib.annotation.NotContributed;
import org.apache.isis.applib.annotation.NotContributed.As;
import org.apache.isis.applib.annotation.NotInServiceMenu;
import org.apache.isis.applib.annotation.Optional;
import org.apache.isis.applib.annotation.ParameterLayout;
+import org.apache.isis.applib.annotation.SemanticsOf;
import org.apache.isis.applib.annotation.Where;
import org.apache.isis.applib.query.QueryDefault;
import org.apache.isis.applib.services.queryresultscache.QueryResultsCache;
@@ -50,11 +49,15 @@ import org.apache.isis.applib.value.Clob;
public class ToDoItemContributions extends AbstractFactoryAndRepository {
//region > priority (contributed property)
- @DescribedAs("The relative priority of this item compared to others not yet complete (using 'due by' date)")
@NotInServiceMenu
- @ActionSemantics(Of.SAFE)
@NotContributed(As.ACTION) // ie contributed as association
- @Hidden(where=Where.ALL_TABLES)
+ @Action(
+ semantics = SemanticsOf.SAFE,
+ hidden = Where.ALL_TABLES
+ )
+ @ActionLayout(
+ describedAs = "The relative priority of this item compared to others not yet complete (using 'due by' date)"
+ )
@Disabled(reason="Relative priority, derived from due date")
public Integer relativePriority(final ToDoItem toDoItem) {
return queryResultsCache.execute(new Callable<Integer>(){
@@ -66,7 +69,7 @@ public class ToDoItemContributions extends AbstractFactoryAndRepository {
// sort items, then locate this one
int i=1;
- for (ToDoItem each : sortedNotYetComplete()) {
+ for (final ToDoItem each : sortedNotYetComplete()) {
if(each == toDoItem) {
return i;
}
@@ -82,18 +85,18 @@ public class ToDoItemContributions extends AbstractFactoryAndRepository {
.sortedCopy(toDoItems.notYetComplete());
}
- private static Ordering<ToDoItem> ORDERING_DUE_BY =
+ private static final Ordering<ToDoItem> ORDERING_DUE_BY =
Ordering.natural().nullsLast().onResultOf(new Function<ToDoItem, LocalDate>(){
@Override
- public LocalDate apply(ToDoItem input) {
+ public LocalDate apply(final ToDoItem input) {
return input.getDueBy();
}
});
- private static Ordering<ToDoItem> ORDERING_DESCRIPTION =
+ private static final Ordering<ToDoItem> ORDERING_DESCRIPTION =
Ordering.natural().nullsLast().onResultOf(new Function<ToDoItem, String>(){
@Override
- public String apply(ToDoItem input) {
+ public String apply(final ToDoItem input) {
return input.getDescription();
}
});
@@ -101,11 +104,13 @@ public class ToDoItemContributions extends AbstractFactoryAndRepository {
//endregion
- //region > next, previous (contributed actions)
- @DescribedAs("The next item not yet completed")
+ //region > next, previous (contributed actions)
@NotInServiceMenu
- @ActionSemantics(Of.SAFE)
@NotContributed(As.ASSOCIATION) // ie contributed as action
+ @Action(semantics = SemanticsOf.SAFE)
+ @ActionLayout(
+ describedAs = "The next item not yet completed"
+ )
public ToDoItem next(final ToDoItem item) {
final Integer priority = relativePriority(item);
if(priority == null) {
@@ -117,7 +122,7 @@ public class ToDoItemContributions extends AbstractFactoryAndRepository {
public String disableNext(final ToDoItem toDoItem) {
if (toDoItem.isComplete()) {
return "Completed";
- }
+ }
if(next(toDoItem) == null) {
return "No next item";
}
@@ -126,10 +131,12 @@ public class ToDoItemContributions extends AbstractFactoryAndRepository {
// //////////////////////////////////////
- @DescribedAs("The previous item not yet completed")
@NotInServiceMenu
- @ActionSemantics(Of.SAFE)
@NotContributed(As.ASSOCIATION) // ie contributed as action
+ @ActionLayout(
+ describedAs = "The previous item not yet completed"
+ )
+ @Action(semantics = SemanticsOf.SAFE)
public ToDoItem previous(final ToDoItem item) {
final Integer priority = relativePriority(item);
if(priority == null) {
@@ -167,8 +174,8 @@ public class ToDoItemContributions extends AbstractFactoryAndRepository {
//region > similarTo (contributed collection)
@NotInServiceMenu
- @ActionSemantics(Of.SAFE)
@NotContributed(As.ACTION)
+ @Action(semantics = SemanticsOf.SAFE)
public List<ToDoItem> similarTo(final ToDoItem toDoItem) {
final List<ToDoItem> similarToDoItems = allMatches(
new QueryDefault<ToDoItem>(ToDoItem.class,
@@ -191,9 +198,11 @@ public class ToDoItemContributions extends AbstractFactoryAndRepository {
//region > updateCategory (contributed action)
- @DescribedAs("Update category and subcategory")
@NotInServiceMenu
- @ActionSemantics(Of.IDEMPOTENT)
+ @ActionLayout(
+ describedAs = "Update category and subcategory"
+ )
+ @Action(semantics = SemanticsOf.IDEMPOTENT)
public Categorized updateCategory(
final Categorized item,
final @ParameterLayout(named="Category") Category category,
http://git-wip-us.apache.org/repos/asf/isis/blob/525c0c45/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItems.java
----------------------------------------------------------------------
diff --git a/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItems.java b/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItems.java
index 67dd4d4..4be995f 100644
--- a/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItems.java
+++ b/example/application/todoapp/dom/src/main/java/dom/todo/ToDoItems.java
@@ -26,17 +26,17 @@ import java.util.List;
import com.google.common.base.Predicates;
import org.joda.time.LocalDate;
import org.apache.isis.applib.DomainObjectContainer;
+import org.apache.isis.applib.annotation.Action;
import org.apache.isis.applib.annotation.ActionLayout;
-import org.apache.isis.applib.annotation.ActionSemantics;
-import org.apache.isis.applib.annotation.ActionSemantics.Of;
-import org.apache.isis.applib.annotation.Bookmarkable;
+import org.apache.isis.applib.annotation.BookmarkPolicy;
import org.apache.isis.applib.annotation.DomainService;
import org.apache.isis.applib.annotation.DomainServiceLayout;
import org.apache.isis.applib.annotation.MemberOrder;
-import org.apache.isis.applib.annotation.Optional;
+import org.apache.isis.applib.annotation.Optionality;
+import org.apache.isis.applib.annotation.Parameter;
import org.apache.isis.applib.annotation.ParameterLayout;
import org.apache.isis.applib.annotation.Programmatic;
-import org.apache.isis.applib.annotation.RegEx;
+import org.apache.isis.applib.annotation.SemanticsOf;
import org.apache.isis.applib.query.QueryDefault;
import org.apache.isis.applib.services.clock.ClockService;
@@ -45,11 +45,11 @@ import org.apache.isis.applib.services.clock.ClockService;
public class ToDoItems {
//region > notYetComplete (action)
+ @Action(semantics = SemanticsOf.SAFE)
@ActionLayout(
- cssClassFa = "fa fa-thumbs-down"
+ cssClassFa = "fa fa-thumbs-down",
+ bookmarking = BookmarkPolicy.AS_ROOT
)
- @Bookmarkable
- @ActionSemantics(Of.SAFE)
@MemberOrder(sequence = "10")
public List<ToDoItem> notYetComplete() {
final List<ToDoItem> items = notYetCompleteNoUi();
@@ -62,7 +62,7 @@ public class ToDoItems {
@Programmatic
public List<ToDoItem> notYetCompleteNoUi() {
return container.allMatches(
- new QueryDefault<ToDoItem>(ToDoItem.class,
+ new QueryDefault<>(ToDoItem.class,
"findByOwnedByAndCompleteIsFalse",
"ownedBy", currentUserName()));
}
@@ -72,7 +72,7 @@ public class ToDoItems {
@ActionLayout(
cssClassFa = "fa fa-thumbs-up"
)
- @ActionSemantics(Of.SAFE)
+ @Action(semantics = SemanticsOf.SAFE)
@MemberOrder(sequence = "20")
public List<ToDoItem> complete() {
final List<ToDoItem> items = completeNoUi();
@@ -85,7 +85,7 @@ public class ToDoItems {
@Programmatic
public List<ToDoItem> completeNoUi() {
return container.allMatches(
- new QueryDefault<ToDoItem>(ToDoItem.class,
+ new QueryDefault<>(ToDoItem.class,
"findByOwnedByAndCompleteIsTrue",
"ownedBy", currentUserName()));
}
@@ -93,12 +93,12 @@ public class ToDoItems {
//region > categorized (action)
@SuppressWarnings("unchecked")
- @Bookmarkable
- @ActionSemantics(Of.SAFE)
- @MemberOrder(sequence = "40")
+ @Action(semantics = SemanticsOf.SAFE)
@ActionLayout(
- cssClassFa = "fa fa-question"
+ cssClassFa = "fa fa-question",
+ bookmarking = BookmarkPolicy.AS_ROOT
)
+ @MemberOrder(sequence = "40")
public List<ToDoItem> categorized(
@ParameterLayout(named="Category") final Category category,
@ParameterLayout(named="Subcategory") final Subcategory subcategory,
@@ -117,7 +117,7 @@ public class ToDoItems {
return default0Categorized().subcategories().get(0);
}
public boolean default2Categorized() {
- return false;
+ return false;
}
public List<Subcategory> choices1Categorized(
final Category category) {
@@ -135,12 +135,20 @@ public class ToDoItems {
@ActionLayout(cssClassFa = "fa fa-plus")
@MemberOrder(sequence = "5")
public ToDoItem newToDo(
- final @RegEx(validation = "\\w[@&:\\-\\,\\.\\+ \\w]*")
- @ParameterLayout(named="Description") String description,
- final @ParameterLayout(named="Category") Category category,
- final @Optional @ParameterLayout(named="Subcategory") Subcategory subcategory,
- final @Optional @ParameterLayout(named="Due by") LocalDate dueBy,
- final @Optional @ParameterLayout(named="Cost") BigDecimal cost) {
+ @Parameter(regexPattern = "\\w[@&:\\-\\,\\.\\+ \\w]*")
+ @ParameterLayout(named="Description")
+ final String description,
+ @ParameterLayout(named="Category")
+ final Category category,
+ @Parameter(optional = Optionality.TRUE)
+ @ParameterLayout(named="Subcategory")
+ final Subcategory subcategory,
+ @Parameter(optional = Optionality.TRUE)
+ @ParameterLayout(named="Due by")
+ final LocalDate dueBy,
+ @Parameter(optional = Optionality.TRUE)
+ @ParameterLayout(named="Cost")
+ final BigDecimal cost) {
return newToDo(description, category, subcategory, currentUserName(), dueBy, cost);
}
public Category default1NewToDo() {
@@ -169,11 +177,11 @@ public class ToDoItems {
cssClassFa = "fa fa-globe",
prototype = true
)
- @ActionSemantics(Of.SAFE)
+ @Action(semantics = SemanticsOf.SAFE)
@MemberOrder(sequence = "50")
public List<ToDoItem> allToDos() {
final List<ToDoItem> items = container.allMatches(
- new QueryDefault<ToDoItem>(ToDoItem.class,
+ new QueryDefault<>(ToDoItem.class,
"findByOwnedBy",
"ownedBy", currentUserName()));
if(items.isEmpty()) {
@@ -187,7 +195,7 @@ public class ToDoItems {
@Programmatic // not part of metamodel
public List<ToDoItem> autoComplete(final String description) {
return container.allMatches(
- new QueryDefault<ToDoItem>(ToDoItem.class,
+ new QueryDefault<>(ToDoItem.class,
"findByOwnedByAndDescriptionContains",
"ownedBy", currentUserName(),
"description", description));
@@ -226,7 +234,7 @@ public class ToDoItems {
private static final long ONE_WEEK_IN_MILLIS = 7 * 24 * 60 * 60 * 1000L;
@Programmatic
- public String validateDueBy(LocalDate dueBy) {
+ public String validateDueBy(final LocalDate dueBy) {
return isMoreThanOneWeekInPast(dueBy) ? "Due by date cannot be more than one week old" : null;
}
@Programmatic
http://git-wip-us.apache.org/repos/asf/isis/blob/525c0c45/example/application/todoapp/fixture/src/main/java/fixture/todo/ToDoItemsFixturesService.java
----------------------------------------------------------------------
diff --git a/example/application/todoapp/fixture/src/main/java/fixture/todo/ToDoItemsFixturesService.java b/example/application/todoapp/fixture/src/main/java/fixture/todo/ToDoItemsFixturesService.java
index e95e73f..77c4687 100644
--- a/example/application/todoapp/fixture/src/main/java/fixture/todo/ToDoItemsFixturesService.java
+++ b/example/application/todoapp/fixture/src/main/java/fixture/todo/ToDoItemsFixturesService.java
@@ -25,7 +25,8 @@ import org.apache.isis.applib.annotation.ActionLayout;
import org.apache.isis.applib.annotation.DomainService;
import org.apache.isis.applib.annotation.DomainServiceLayout;
import org.apache.isis.applib.annotation.MemberOrder;
-import org.apache.isis.applib.annotation.Optional;
+import org.apache.isis.applib.annotation.Optionality;
+import org.apache.isis.applib.annotation.Parameter;
import org.apache.isis.applib.annotation.ParameterLayout;
import org.apache.isis.applib.fixturescripts.FixtureResult;
import org.apache.isis.applib.fixturescripts.FixtureScript;
@@ -35,7 +36,10 @@ import org.apache.isis.applib.fixturescripts.FixtureScripts;
* Enables fixtures to be installed from the application.
*/
@DomainService
-@DomainServiceLayout(named = "Prototyping", menuBar = DomainServiceLayout.MenuBar.SECONDARY, menuOrder = "10")
+@DomainServiceLayout(
+ named = "Prototyping",
+ menuBar = DomainServiceLayout.MenuBar.SECONDARY,
+ menuOrder = "10")
public class ToDoItemsFixturesService extends FixtureScripts {
public ToDoItemsFixturesService() {
@@ -49,12 +53,12 @@ public class ToDoItemsFixturesService extends FixtureScripts {
@Override
public List<FixtureResult> runFixtureScript(
final FixtureScript fixtureScript,
- final @ParameterLayout(
+ @ParameterLayout(
named="Parameters",
describedAs = "Script-specific parameters (key=value) ",
multiLine = 10)
- @Optional
- String parameters) {
+ @Parameter(optional = Optionality.TRUE)
+ final String parameters) {
return super.runFixtureScript(fixtureScript, parameters);
}
http://git-wip-us.apache.org/repos/asf/isis/blob/525c0c45/example/application/todoapp/webapp/src/main/java/webapp/ToDoApplication.java
----------------------------------------------------------------------
diff --git a/example/application/todoapp/webapp/src/main/java/webapp/ToDoApplication.java b/example/application/todoapp/webapp/src/main/java/webapp/ToDoApplication.java
index a686b34..e81dddc 100644
--- a/example/application/todoapp/webapp/src/main/java/webapp/ToDoApplication.java
+++ b/example/application/todoapp/webapp/src/main/java/webapp/ToDoApplication.java
@@ -78,7 +78,7 @@ public class ToDoApplication extends IsisWicketApplication {
protected void init() {
super.init();
- IBootstrapSettings settings = Bootstrap.getSettings();
+ final IBootstrapSettings settings = Bootstrap.getSettings();
settings.setThemeProvider(new BootswatchThemeProvider(BootswatchTheme.Flatly));
}
@@ -97,21 +97,21 @@ public class ToDoApplication extends IsisWicketApplication {
}
@Override
- public WebRequest newWebRequest(HttpServletRequest servletRequest, String filterPath) {
+ public WebRequest newWebRequest(final HttpServletRequest servletRequest, final String filterPath) {
if(!DEMO_MODE_USING_CREDENTIALS_AS_QUERYARGS) {
return super.newWebRequest(servletRequest, filterPath);
}
// else demo mode
try {
- String uname = servletRequest.getParameter("user");
+ final String uname = servletRequest.getParameter("user");
if (uname != null) {
servletRequest.getSession().invalidate();
}
- } catch (Exception e) {
+ } catch (Exception ignored) {
}
- WebRequest request = super.newWebRequest(servletRequest, filterPath);
- return request;
+
+ return super.newWebRequest(servletRequest, filterPath);
}
@Override
@@ -136,10 +136,11 @@ public class ToDoApplication extends IsisWicketApplication {
private static String readLines(final Class<?> contextClass, final String resourceName) {
try {
- List<String> readLines = Resources.readLines(Resources.getResource(contextClass, resourceName), Charset.defaultCharset());
+ final List<String> readLines = Resources.readLines(
+ Resources.getResource(contextClass, resourceName), Charset.defaultCharset());
final String aboutText = Joiner.on("\n").join(readLines);
return aboutText;
- } catch (IOException e) {
+ } catch (final IOException e) {
return "This is a Todo app";
}
}
http://git-wip-us.apache.org/repos/asf/isis/blob/525c0c45/example/application/todoapp/webapp/src/main/java/webapp/prototyping/ExternalLinksService.java
----------------------------------------------------------------------
diff --git a/example/application/todoapp/webapp/src/main/java/webapp/prototyping/ExternalLinksService.java b/example/application/todoapp/webapp/src/main/java/webapp/prototyping/ExternalLinksService.java
index 8bfcd02..81b0570 100644
--- a/example/application/todoapp/webapp/src/main/java/webapp/prototyping/ExternalLinksService.java
+++ b/example/application/todoapp/webapp/src/main/java/webapp/prototyping/ExternalLinksService.java
@@ -18,16 +18,19 @@ package webapp.prototyping;
import java.net.MalformedURLException;
import java.net.URL;
+import org.apache.isis.applib.annotation.Action;
import org.apache.isis.applib.annotation.ActionLayout;
-import org.apache.isis.applib.annotation.ActionSemantics;
-import org.apache.isis.applib.annotation.ActionSemantics.Of;
import org.apache.isis.applib.annotation.DomainService;
import org.apache.isis.applib.annotation.DomainServiceLayout;
import org.apache.isis.applib.annotation.MemberOrder;
import org.apache.isis.applib.annotation.ParameterLayout;
+import org.apache.isis.applib.annotation.SemanticsOf;
@DomainService
-@DomainServiceLayout(menuBar = DomainServiceLayout.MenuBar.SECONDARY, menuOrder = "20")
+@DomainServiceLayout(
+ menuBar = DomainServiceLayout.MenuBar.SECONDARY,
+ menuOrder = "20"
+)
public class ExternalLinksService {
public static enum ExternalLink {
@@ -55,7 +58,7 @@ public class ExternalLinksService {
cssClassFa = "fa-external-link" ,
prototype = true
)
- @ActionSemantics(Of.SAFE)
+ @Action(semantics = SemanticsOf.SAFE)
@MemberOrder(name="Prototyping", sequence="91.1")
public URL goToDocs(@ParameterLayout(named="Link") ExternalLink link) throws MalformedURLException {
return link.open();
http://git-wip-us.apache.org/repos/asf/isis/blob/525c0c45/example/application/todoapp/webapp/src/main/java/webapp/prototyping/WicketDeveloperUtilities.java
----------------------------------------------------------------------
diff --git a/example/application/todoapp/webapp/src/main/java/webapp/prototyping/WicketDeveloperUtilities.java b/example/application/todoapp/webapp/src/main/java/webapp/prototyping/WicketDeveloperUtilities.java
index c1ade8e..67425af 100644
--- a/example/application/todoapp/webapp/src/main/java/webapp/prototyping/WicketDeveloperUtilities.java
+++ b/example/application/todoapp/webapp/src/main/java/webapp/prototyping/WicketDeveloperUtilities.java
@@ -27,11 +27,14 @@ import org.apache.isis.viewer.wicket.viewer.applib.WicketDeveloperUtilitiesServi
* 'Prototyping' menu.
*/
@DomainService
-@DomainServiceLayout(menuBar = DomainServiceLayout.MenuBar.SECONDARY, menuOrder = "40")
+@DomainServiceLayout(
+ menuBar = DomainServiceLayout.MenuBar.SECONDARY,
+ named = "Prototyping",
+ menuOrder = "40")
public class WicketDeveloperUtilities extends WicketDeveloperUtilitiesService {
@ActionLayout(named="Clear i18n Cache")
- @MemberOrder(name="Prototyping", sequence="90.3")
+ @MemberOrder(sequence="90.3")
@Override
public void resetI18nCache() {
super.resetI18nCache();