io.legaldocml.akn.element

Class Note

java.lang.Object

io.legaldocml.akn.element.AbstractId

io.legaldocml.akn.element.AbstractCore

io.legaldocml.akn.element.SubFlowStructure

io.legaldocml.akn.element.Note

All Implemented Interfaces:

AknObject, Alt, Core, CoreReq, Enactment, HTMLattrs, Id, IdReq, Notes, Period, Refers, RefersOpt, ANblockContainer, ANhierContainer, BlockElementsContainer, Container, HierElementsContainer, HTMLblockContainer, Visitable, Externalizable

public final class Note
extends SubFlowStructure
implements Notes

The element note is a metadata element containing the text of the footnote and endnote specified.

  <xsd:element name=“note”>  <xsd:complexType>  <xsd:complexContent>  <xsd:extension base=“subFlowStructure”>  <xsd:attributeGroup ref=“notes”/>  <xsd:extension>  <xsd:complexContent>  <xsd:complexType>  <xsd:element> 

Author:

Jacques Militello

Constructor Summary

Constructors

Constructor and Description
Note()

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableMap<String,AttributeGetterSetter<AknObject>>	attributes() To read attributes.
String	getMarker()
PlacementType	getPlacement()
EidRef	getPlacementBase()
String	name() Name of this object (the name of the xml element)
void	setMarker(String marker)
void	setPlacement(PlacementType placement)
void	setPlacementBase(EidRef placementBase)
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.SubFlowStructure

accept, add, add, add, add, add, addSubFlowStructureElement, read, remove, remove, remove, removeSubFlowStructureElement

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

add, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.legaldocml.akn.AknObject

compare, nestedCompare

Methods inherited from interface io.legaldocml.io.Externalizable

read

Methods inherited from interface io.legaldocml.akn.visitor.Visitable

accept

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

add, getAttributes, nestedCompare

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.container.Container

stream

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

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

Constructor Detail

Note

public Note()

Method Detail

getMarker

public String getMarker()

Specified by:

getMarker in interface Notes

setMarker

public void setMarker(String marker)

Specified by:

setMarker in interface Notes

getPlacement

public PlacementType getPlacement()

Specified by:

getPlacement in interface Notes

setPlacement

public void setPlacement(PlacementType placement)

Specified by:

setPlacement in interface Notes

getPlacementBase

public EidRef getPlacementBase()

Specified by:

getPlacementBase in interface Notes

setPlacementBase

public void setPlacementBase(EidRef placementBase)

Specified by:

setPlacementBase in interface Notes

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 SubFlowStructure

Parameters:

writer - the stream to write the object to

Throws:

IOException

name

public String name()

Name of this object (the name of the xml element)

Specified by:

name in interface AknObject

attributes

public com.google.common.collect.ImmutableMap<String,AttributeGetterSetter<AknObject>> attributes()

To read attributes.

Specified by:

attributes in interface AknObject

Overrides:

attributes in class AbstractCore