io.legaldocml.akn.element

Class Hierarchy

java.lang.Object

io.legaldocml.akn.element.AbstractId

io.legaldocml.akn.element.AbstractCore

io.legaldocml.akn.element.BaseHierarchy

io.legaldocml.akn.element.Hierarchy

All Implemented Interfaces:

AknObject, Alt, Core, CoreReq, Enactment, HTMLattrs, Id, IdReq, Period, Refers, RefersOpt, ANhierContainer<HierarchyElement>, Container<HierarchyElement>, HierElementsContainer<HierarchyElement>, Visitable, Externalizable

Direct Known Subclasses:

Alinea, Article, Book, Chapter, Clause, Division, Hcontainer, Indent, Level, List, Paragraph, Part, Point, Proviso, Rule, Section, Subchapter, Subclause, Subdivision, Sublist, Subparagraph, Subpart, Subrule, Subsection, Subtitle, Title, Tome, Transitional

public abstract class Hierarchy
extends BaseHierarchy
implements CoreReq, HierElementsContainer<HierarchyElement>

The complex type hierarchy is used by most or all the hierarchical elements of act-like documents.

  <xsd:complexType name=“hierarchy”>  <xsd:complexContent>  <xsd:extension base=“basehierarchy”>  <xsd:choice>  <xsd:sequence>  <xsd:element ref=“intro” minOccurs=“0” maxOccurs=“1”/>  <xsd:choice minOccurs=“0” maxOccurs=“unbounded”>  <xsd:element ref=“componentRef”/>  <xsd:group ref=“hierElements”/>  <xsd:element ref=“crossHeading”/>  </xsd:choice>  <xsd:element ref=“wrapUp” minOccurs=“0” maxOccurs=“1”/>  </xsd:sequence>  <xsd:element ref=“content”/>  </xsd:choice>  <xsd:attributeGroup ref=“corereq”/>  </xsd:extension>  </xsd:complexContent>  </xsd:complexType> 

Author:

Jacques Militello

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.collect.ImmutableMap<String,Supplier<HierarchyElement>>	ELEMS

Fields inherited from class io.legaldocml.akn.element.AbstractCore

ATTRIBUTES

Constructor Summary

Constructors

Constructor and Description
Hierarchy()

Method Summary

Modifier and Type	Method and Description
void	accept(AknVisitor visitor)
void	add(ANhier hier)
void	add(HierElements hier)
void	addHierarchyElement(HierarchyElement element)
boolean	equals(Object obj)
Content	getContent()
Intro	getIntro()
void	nestedCompare(AknObject object, DiffContext context)
void	read(XmlReader reader) The object implements the read method to restore its contents by calling the methods of Input.
boolean	remove(HierElements hier)
HierarchyElement	remove(int index)
boolean	removeHierarchyElement(HierarchyElement element)
void	setContent(Content content)
void	setIntro(Intro intro)
Stream<HierarchyElement>	stream()
void	write(XmlWriter writer) The object implements the write method to save its contents by calling the methods of Output.

Methods inherited from class io.legaldocml.akn.element.BaseHierarchy

getHeading, getNum, getSubheading, setHeading, setNum, setSubheading

Methods inherited from class io.legaldocml.akn.element.AbstractCore

add, attributes, getAlternativeTo, getAttributes, getClazz, getPeriod, getRefersTo, getStatus, getStyle, getTitle, setAlternativeTo, setClazz, setPeriod, setRefersTo, setStatus, setStyle, setTitle, toString

Methods inherited from class io.legaldocml.akn.element.AbstractId

getEid, getEvolvingId, getGUID, getId, getWid, setEid, setEvolvingId, setGUID, setId, setWid, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.legaldocml.akn.attribute.Core

add, getAttributes

Methods inherited from interface io.legaldocml.akn.attribute.HTMLattrs

getClazz, getStyle, getTitle, setClazz, setStyle, setTitle

Methods inherited from interface io.legaldocml.akn.attribute.Enactment

getStatus, setStatus

Methods inherited from interface io.legaldocml.akn.attribute.Period

getPeriod, setPeriod

Methods inherited from interface io.legaldocml.akn.attribute.Refers

getRefersTo, setRefersTo

Methods inherited from interface io.legaldocml.akn.attribute.Alt

getAlternativeTo, setAlternativeTo

Methods inherited from interface io.legaldocml.akn.attribute.Id

getEid, getEvolvingId, getGUID, getId, getWid, setEid, setEvolvingId, setGUID, setId, setWid

Field Detail

ELEMS

public static final com.google.common.collect.ImmutableMap<String,Supplier<HierarchyElement>> ELEMS

Constructor Detail

Hierarchy

public Hierarchy()

Method Detail

addHierarchyElement

public final void addHierarchyElement(HierarchyElement element)

removeHierarchyElement

public final boolean removeHierarchyElement(HierarchyElement element)

remove

public final HierarchyElement remove(int index)

Specified by:

remove in interface Container<HierarchyElement>

add

public final void add(HierElements hier)

Specified by:

add in interface HierElementsContainer<HierarchyElement>

remove

public boolean remove(HierElements hier)

Specified by:

remove in interface HierElementsContainer<HierarchyElement>

add

public final void add(ANhier hier)

Specified by:

add in interface ANhierContainer<HierarchyElement>

stream

public Stream<HierarchyElement> stream()

Specified by:

stream in interface Container<HierarchyElement>

write

public void write(XmlWriter writer)
           throws IOException

The object implements the write method to save its contents by calling the methods of Output.

Specified by:

write in interface Core

Specified by:

write in interface CoreReq

Specified by:

write in interface IdReq

Specified by:

write in interface Externalizable

Overrides:

write in class BaseHierarchy

Parameters:

writer - the stream to write the object to

Throws:

IOException

read

public void read(XmlReader reader)

The object implements the read method to restore its contents by calling the methods of Input.

Specified by:

read in interface Externalizable

Overrides:

read in class BaseHierarchy

Parameters:

reader - the stream to read data from in order to restore the object

getContent

public final Content getContent()

setContent

public final void setContent(Content content)

setIntro

public final void setIntro(Intro intro)

getIntro

public final Intro getIntro()

accept

public void accept(AknVisitor visitor)

Specified by:

accept in interface Visitable

Overrides:

accept in class BaseHierarchy

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

nestedCompare

public void nestedCompare(AknObject object,
                          DiffContext context)

Specified by:

nestedCompare in interface AknObject

Specified by:

nestedCompare in interface Core