io.legaldocml.business.util.EidFactory Maven / Gradle / Ivy
The newest version!
package io.legaldocml.business.util;
import com.google.common.collect.ImmutableMap;
import io.legaldocml.akn.AknObject;
import io.legaldocml.akn.attribute.Id;
import io.legaldocml.akn.element.Alinea;
import io.legaldocml.akn.element.AmendmentBody;
import io.legaldocml.akn.element.Article;
import io.legaldocml.akn.element.Attachment;
import io.legaldocml.akn.element.BlockList;
import io.legaldocml.akn.element.Body;
import io.legaldocml.akn.element.Chapter;
import io.legaldocml.akn.element.Citation;
import io.legaldocml.akn.element.Citations;
import io.legaldocml.akn.element.Clause;
import io.legaldocml.akn.element.Component;
import io.legaldocml.akn.element.ComponentRef;
import io.legaldocml.akn.element.Components;
import io.legaldocml.akn.element.DebateBody;
import io.legaldocml.akn.element.DebateSection;
import io.legaldocml.akn.element.Division;
import io.legaldocml.akn.element.DocumentRef;
import io.legaldocml.akn.element.EventRef;
import io.legaldocml.akn.element.Intro;
import io.legaldocml.akn.element.JudgmentBody;
import io.legaldocml.akn.element.List;
import io.legaldocml.akn.element.ListIntroduction;
import io.legaldocml.akn.element.ListWrapUp;
import io.legaldocml.akn.element.MainBody;
import io.legaldocml.akn.element.Paragraph;
import io.legaldocml.akn.element.QuotedStructure;
import io.legaldocml.akn.element.QuotedText;
import io.legaldocml.akn.element.Recital;
import io.legaldocml.akn.element.Recitals;
import io.legaldocml.akn.element.Section;
import io.legaldocml.akn.element.Subchapter;
import io.legaldocml.akn.element.Subclause;
import io.legaldocml.akn.element.Subdivision;
import io.legaldocml.akn.element.Subparagraph;
import io.legaldocml.akn.element.Subsection;
import io.legaldocml.akn.element.TemporalGroup;
import io.legaldocml.akn.element.WrapUp;
import io.legaldocml.akn.type.NoWhiteSpace;
import io.legaldocml.unsafe.UnsafeString;
import io.legaldocml.util.Strings;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @see Syntax for eId and wId attributes
* Most elements in the Akoma Ntoso XML vocabulary allow two optional attributes, called eId and wId. They are optional for compliance level 1, and are required for compliance levels 2 and above.
* The syntax for these attributes is identical and is built in the exact same way, but are based on different elements:
*
* - for the eId attribute, the reference element is the one in the current Expression
* - for the wId attribute, the reference element is the one in the master Expression, as specified in section 5.4.
*
* The generic syntax for these attributes is the following:
*
* [prefix “__”] element_ref [“_”number]
*
*
* - prefix is a (possibly empty) string providing uniqueness to the remaining part of the identifier, and it is based on the context in which the element appears;
* - element_ref is a (required) identifier of the type of the element;
* - number is a (possibly empty) representation of the numbering of the element within its context.
*
*/
public final class EidFactory {
/**
* SLF4J Logger.
*/
private static final Logger LOGGER = LoggerFactory.getLogger(EidFactory.class);
/**
* Map of default element ref mappings.
*/
private static final ImmutableMap, String> ELEMENTS_REFS;
static {
ELEMENTS_REFS = ImmutableMap., String>builder()
.put(Body.class, "body")
.put(Alinea.class, "al")
.put(AmendmentBody.class, "body")
.put(Article.class, "art")
.put(Attachment.class, "att")
.put(BlockList.class, "list")
.put(Chapter.class, "chp")
.put(Citation.class, "cit")
.put(Citations.class, "cits")
.put(Clause.class, "cl")
.put(Component.class, "cmp")
.put(Components.class, "cmpnts")
.put(ComponentRef.class, "cref")
.put(DebateBody.class, "body")
.put(DebateSection.class, "dbsect")
.put(Division.class, "dvs")
.put(DocumentRef.class, "dref")
.put(EventRef.class, "eref")
.put(JudgmentBody.class, "body")
.put(Intro.class, "intro")
.put(List.class, "list")
.put(ListIntroduction.class, "intro")
.put(ListWrapUp.class, "wrap")
.put(MainBody.class, "body")
.put(Paragraph.class, "para")
.put(QuotedStructure.class, "qstr")
.put(QuotedText.class, "qtext")
.put(Recital.class, "rec")
.put(Recitals.class, "recs")
.put(Section.class, "sec")
.put(Subchapter.class, "subchp")
.put(Subclause.class, "subcl")
.put(Subdivision.class, "subdvs")
.put(Subparagraph.class, "subpara")
.put(Subsection.class, "subsec")
.put(TemporalGroup.class, "tmpg")
.put(WrapUp.class, "wrapup")
.build();
}
public static String getElementRef(Class clazz) {
return ELEMENTS_REFS.get(clazz);
}
public static void makeAndFill(Id object) {
NoWhiteSpace space = make(null,object, null);
object.setEid(space);
}
public static void makeAndFill(Id object, String number) {
NoWhiteSpace space = make(object, number);
object.setEid(space);
}
public static void makeAndFill(Id parent, Id object) {
NoWhiteSpace space = make(parent, object, null);
object.setEid(space);
}
public static void makeAndFill(Id parent, Id object, String number) {
NoWhiteSpace space = make(parent, object, number);
object.setEid(space);
}
public static NoWhiteSpace make(Id object, String number) {
return make(null, object, number);
}
public static NoWhiteSpace make(Id parent, Id object) {
return make(parent, object, null);
}
public static NoWhiteSpace make(Id parent, Id object, String number) {
if (object.getEid() != null) {
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Object [{}] has already an eId", object);
}
return object.getEid();
}
EidFactory builder = new EidFactory();
if (parent != null && parent.getEid() != null) {
builder.append(parent.getEid());
builder.appendPrefixSeparator();
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Parent eid : [{}]", parent.getEid());
}
}
String ref = ELEMENTS_REFS.get(object.getClass());
if (ref == null) {
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Class [{}] not defined -> use name [{}]", object.getClass().getSimpleName(), object.name());
}
ref = object.name();
}
builder.append(ref);
if (!Strings.isEmpty(number)) {
builder.appendSeparator();
builder.append(number);
}
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Make eId [{}]", builder);
}
return builder.build();
}
private NoWhiteSpace build() {
return NoWhiteSpace.valueOf(UnsafeString.getChars(builder.toString()));
}
private static final char[] PREFIX_SEPARATOR = new char[]{'_', '_'};
private static final char REF_SEPARATOR = '_';
private final StringBuilder builder = new StringBuilder();
private EidFactory() {
}
private void appendPrefixSeparator() {
builder.append(PREFIX_SEPARATOR);
}
private void append(NoWhiteSpace eid) {
builder.append(eid.getChars());
}
private void append(String ref) {
builder.append(ref);
}
private void appendSeparator() {
builder.append(REF_SEPARATOR);
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return builder.toString();
}
}