org.apache.isis.core.metamodel.layout

Class DeweyOrderSet

java.lang.Object

org.apache.isis.core.metamodel.layout.DeweyOrderSet

All Implemented Interfaces:

Comparable<DeweyOrderSet>, Iterable<Object>

public class DeweyOrderSet
extends Object
implements Comparable<DeweyOrderSet>, Iterable<Object>

Represents a nested hierarchy of ordered members.

At each level the elements are either FacetedMethods or they are instances of OrderSet represent a group of FacetedMethods that have a MemberOrderFacet of the same name.

With no name, (ie name="" is the default), at the top level

 MemberOrder(sequence="1")
 MemberOrder(sequence="1.1")
 MemberOrder(sequence="1.2")
 MemberOrder(sequence="1.2.1")
 MemberOrder(sequence="1.3")
 

With names, creates a hierarchy.

 MemberOrder(sequence="1.1")                   // no parent
 MemberOrder(sequence="1.2.1")
 MemberOrder(sequence="1.3")
 MemberOrder(name="abc", sequence="1")         // group is abc, parent is ""
 MemberOrder(name="abc", sequence="1.2")
 MemberOrder(name="abc,def", sequence="1")     // group is def, parent is abc
 MemberOrder(name="abc,def", sequence="1.2")
 

Field Summary

Fields

Modifier and Type	Field and Description
protected SortedSet<DeweyOrderSet>	childOrderSets A staging area until we are ready to add the child sets to the collection of elements owned by the superclass.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAll(SortedSet<?> sortedMembers)
protected void	addChild(DeweyOrderSet childOrderSet)
protected void	addElement(Object element)
List<DeweyOrderSet>	children()
int	compareTo(DeweyOrderSet o) Natural ordering is to compare by getGroupFullName().
protected void	copyOverChildren()
static DeweyOrderSet	createOrderSet(List<? extends IdentifiedHolder> identifiedHolders)
List<Object>	elementList() Returns a copy of the elements, in sequence.
boolean	equals(Object obj)
String	getGroupFullName() The group name exactly as it was supplied in the constructor (analogous to a fully qualified file name).
String	getGroupName() Last component of the comma-separated group name supplied in the constructor (analogous to the file name extracted from a fully qualified file name).
String	getGroupPath() Represents the parent groups, derived from the group name supplied in the constructor (analogous to the directory portion of a fully qualified file name).
DeweyOrderSet	getParent()
int	hashCode()
Iterator<Object>	iterator()
void	reorderChildren(List<String> requiredOrder)
protected void	setParent(DeweyOrderSet parent)
int	size()
String	toString() Format is: abc,def:XXel/YYm/ZZch

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

childOrderSets

protected SortedSet<DeweyOrderSet> childOrderSets

A staging area until we are ready to add the child sets to the collection of elements owned by the superclass.

Method Detail

createOrderSet

public static DeweyOrderSet createOrderSet(List<? extends IdentifiedHolder> identifiedHolders)

getGroupName

public String getGroupName()

Last component of the comma-separated group name supplied in the constructor (analogous to the file name extracted from a fully qualified file name).

For example, if supplied abc,def,ghi in the constructor, then this will return ghi.

getGroupFullName

public String getGroupFullName()

The group name exactly as it was supplied in the constructor (analogous to a fully qualified file name).

For example, if supplied abc,def,ghi in the constructor, then this will return the same string abc,def,ghi.

getGroupPath

public String getGroupPath()

Represents the parent groups, derived from the group name supplied in the constructor (analogous to the directory portion of a fully qualified file name).

For example, if supplied abc,def,ghi in the constructor, then this will return abc,def.

setParent

protected void setParent(DeweyOrderSet parent)

getParent

public DeweyOrderSet getParent()

addChild

protected void addChild(DeweyOrderSet childOrderSet)

children

public List<DeweyOrderSet> children()

copyOverChildren

protected void copyOverChildren()

elementList

public List<Object> elementList()

Returns a copy of the elements, in sequence.

size

public int size()

addElement

protected void addElement(Object element)

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<Object>

addAll

protected void addAll(SortedSet<?> sortedMembers)

reorderChildren

public void reorderChildren(List<String> requiredOrder)

compareTo

public int compareTo(DeweyOrderSet o)

Natural ordering is to compare by getGroupFullName().

Specified by:

compareTo in interface Comparable<DeweyOrderSet>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Format is: abc,def:XXel/YYm/ZZch

where abc,def is group name, XX is number of elements, YY is number of members, and ZZ is number of child order sets.

Overrides:

toString in class Object