Package com.neurosys.domain

Interface Summary

Interface	Description
AbsrtactHierarchialItem<T>	Represents any entitry that has children of the similar type
AbstractAttribute<K,V>
Attribute<E,V>	Define Attribute type Entities This differs from Attributes in the sense that an instance of this represents the Attribute itself while Attributes represents the entity containing the Attributes.
Attributes<T,V>	A way to commonly signify and write common services on objects that use properties This differs from Attribute in the sense that an instance of this represents the Entity having Attribute accessors while an Attribute represents the Attribute itself
Auditable	A marker interface to imply that the Domain Object would be Audited into special files and any design on the Object should consider the following: Security considerations toString method, carefully written to ensure legibility,security,accuracy,brevity of all that is written from this object Serialization
AuxData<T>	Data that isn't part of core persistent or core data, but used for State or Reporting purposes to avoid complex or expensive derivation (transient in nature).
BIT_MASKS	Define a consistent interface for BIT+MASKS enums so that they maybe extended for custom projects
Chainable<T>	Allow chaining of a Bean.
Consumable	Some states (like events), may want to maintain if they were already consumed or nor
ContextConsumer<CONTEXT>	Any class that consumes a context.
DateRange	A Date Range
Displayable	Anything that can be displayed.
IChild<T>	Identity Interface to mark the object as a Child of something that knows its parent
IHierarchialReference<I>	An instance that can act as a reference to some Hierarchial item.
LocaleDisplayable	When there are multiple Locales available; then return the Displayable.getDisplayName() corresponding to the Locale A LocaleDisplayable will not guarantee a different value for each locale, value is always only one in most cases.
Localizable	Allows an object to have a Locale value
NamespaceEntity	Any entity that belongs within a namespace. A namespaced entity, would have a name.
OrderableByRef<R>	An object that can be ordered by its OrderableByRef.getCurrentRef(), OrderableByRef.getNextRef() or OrderableByRef.getPreviousRef(). For example if Id is Long type; then OrderableByRef.getNextRef() can refer to the Id that will follow this, similarly OrderableByRef.getPreviousRef() will refer to the Id that is before/previous to this.
SerializablePredicate	A Predicate that is Serializable
Shell<E>	A Shell provides an environment context to interact with for a session of engagement. Any shell must contain a Base level, which cannot be unwrapped, while a Shell can also be wrapped.
StoreMap<K,V>	A Map that is used for the purpose of storing simple key/value pairs.
TransientAwareModel	A transient model that can tell if it lost its transient values and knows how to recover them.
UpdatableContext<CONTEXT>	Some classes that need to be Serializable may contain certain context members that cannot be Serialized.

Class Summary

Class	Description
CaseInsensitiveHashMap<T>	A case-insensitive version of HashMap where the keys will all be the same as as long as they contain the same alphabets in the same lexical order. Does not allow insertion of null keys.
CaseInsensitiveHashSet	Allow Case insensitive comparisons
CaseInsensitiveList	Allow Case insensitive comparisons
ChainableWrapper<T>	Make it possible to Filter.Chain objects that do not implement Filter.Chain Sometimes even Lambda expressions can make a mess of things.
DomainObject	Base Domain Object
EntityAttribute<E>
Entry<K,V>	A Serializable implementation of java.util.Map.Entry
EnumMorpher	A convenient way to convert Enum values back to Enum constants during JSON unmarshalling
ExternalQuery<T>	A Query specially used to address external query requests, where field members as classes may or may not exist.
GenericAware<T>	Any class that extends this is aware of its Generic Type.
HierarchialDomainObject	A MappedSuperclass implementation of IHierarchialReference objects.
HierarchialDomainObjectWithAttributes<E extends HierarchialDomainObjectWithAttributes,EA extends EntityAttribute<E>>	A generic HierarchialDomainObject with EntityAttributes
ImmutableValueHashMap<K,V>	Once a value is written it cannot be replaced.
JsonQuery	A Query specially used to address external query requests in JSON.
Locale	Entity version of Locale (extend this and embed or make relation to), use wherever we need multiple values for each Locale.
ModelObject	Any object that will experience Marshalling and unMarshalling from one medium to another over and above any Serialization needs.
OrderByRefList<O extends OrderableByRef<Number>>	A list, when OrderableByRef types are added then they are automatically ordered in the correct order on Add Ordering
Progress	Current Progress
Query<T>	Allow generic queries to represent their corresponding entities.
Status	A Feedback or Status Object that can Allow communication of changes in a Synchronous or ASynchronous environment
StoreHashMap<K,V>
Tag	Deprecated
TwoWayTransformer	A wrapper that allows bi-directions to (Data to Presentation)/from (Presentation to Data) Transformation or situations where a Transformer may have a dual purpose in both directions of the Transformation process The default Transformer.transform(Object) is
UniqueList<E>	Ensures an ArrayList will contain only unique values, where unique is defined by ArrayList.contains(Object) if it already exists or not.
UserShell<U extends User,E>	Any environment that needs a user context can use a UserShell Any instance specific to the shell will not be accessible to a parent or child.

Annotation Types Summary

Annotation Type	Description
CollectionElementType	Sometimes it maybe hard to introspect Collection Types.
Queryable	A field level annotation that decides if a field can be queried upon.
Type	If we want to Dynamically interpret a Domain Objects fields as some type (beyond the type described by the field), like say type of Content to render on UI etc.