io.legaldocml.akn.element.FRBRtranslation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of legaldocml-core Show documentation
The newest version!
package io.legaldocml.akn.element;

import com.google.common.collect.ImmutableMap;
import io.legaldocml.akn.AknObject;
import io.legaldocml.akn.attribute.Agent;
import io.legaldocml.akn.attribute.Authoritative;
import io.legaldocml.akn.attribute.FromLanguage;
import io.legaldocml.akn.attribute.LinkReq;
import io.legaldocml.akn.attribute.Pivot;
import io.legaldocml.akn.type.AgentRef;
import io.legaldocml.akn.type.Uri;
import io.legaldocml.akn.visitor.AknVisitor;
import io.legaldocml.io.AttributeGetterSetter;
import io.legaldocml.io.XmlWriter;
import io.legaldocml.io.impl.Buffers;

import java.io.IOException;

import static io.legaldocml.akn.AknAttributes.AUTHORITATIVE;
import static io.legaldocml.akn.AknAttributes.BY;
import static io.legaldocml.akn.AknAttributes.FROM_LANGUAGE;
import static io.legaldocml.akn.AknAttributes.HREF;
import static io.legaldocml.akn.AknAttributes.PIVOT;
import static io.legaldocml.akn.AknElements.FRBR_TRANSLATION;
import static io.legaldocml.akn.element.Attributes.attributeGetterSetter4AgentRef;
import static io.legaldocml.akn.element.Attributes.attributeGetterSetter4Boolean;
import static io.legaldocml.akn.element.Attributes.attributeGetterSetter4String;
import static io.legaldocml.akn.element.Attributes.attributeGetterSetter4Uri;
import static io.legaldocml.akn.util.XmlWriterHelper.writeAgent;
import static io.legaldocml.akn.util.XmlWriterHelper.writeAuthoritative;
import static io.legaldocml.akn.util.XmlWriterHelper.writeFromLanguage;
import static io.legaldocml.akn.util.XmlWriterHelper.writeLinkReq;
import static io.legaldocml.akn.util.XmlWriterHelper.writePivot;
import static io.legaldocml.unsafe.UnsafeHelper.getFieldOffset;

/**
 * The element FRBRtranslation is the metadata property specifying the source of which this expression is a translation
 * of.
 *
 *  *   
 *     
 * 	     
 * 		   
 * 		     
 *           
 *           
 *           
 *           
 * 		   
 * 	     
 *     
 *   
 * 
 *
 * @author Jacques Militello
 */
public final class FRBRtranslation extends MetaOpt implements LinkReq, Authoritative, Agent, Pivot, FromLanguage {

    /**
     * Memory address.
     */
    private static final long ADDRESS_FRBR_TRANSLATION = Buffers.address(FRBR_TRANSLATION);

    private static final ImmutableMap> ATTRIBUTES;

    static {
        ATTRIBUTES = ImmutableMap.>builder()
                .putAll(MetaOpt.ATTRIBUTES)
                .put(HREF, attributeGetterSetter4Uri(HREF, getFieldOffset(FRBRtranslation.class, "href")))
                .put(FROM_LANGUAGE, attributeGetterSetter4String(FROM_LANGUAGE, getFieldOffset(FRBRtranslation.class, "fromLanguage")))
                .put(BY, attributeGetterSetter4AgentRef(BY, getFieldOffset(FRBRtranslation.class, "by")))
                .put(PIVOT, attributeGetterSetter4String(PIVOT, getFieldOffset(FRBRtranslation.class, "pivot")))
                .put(AUTHORITATIVE, attributeGetterSetter4Boolean(AUTHORITATIVE, getFieldOffset(FRBRtranslation.class, "authoritative")))
                .build();
    }


    // Mandatory (from Link)
    private Uri href;

    // Mandatory
    private String fromLanguage;

    // Mandatory
    private AgentRef by;

    // Optional
    private String pivot;

    // Optional
    private Boolean authoritative;

    /**
     * {@inheritDoc}
     */
    public Uri getHref() {
        return this.href;
    }

    /**
     * {@inheritDoc}
     */
    public void setHref(Uri href) {
        this.href = href;
    }

    /**
     * {@inheritDoc}
     */
    public String getFromLanguage() {
        return this.fromLanguage;
    }

    /**
     * {@inheritDoc}
     */
    public void setFromLanguage(String fromLanguage) {
        this.fromLanguage = fromLanguage;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getPivot() {
        return this.pivot;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setPivot(String pivot) {
        this.pivot = pivot;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public AgentRef getBy() {
        return this.by;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setBy(AgentRef by) {
        this.by = by;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Boolean getAuthoritative() {
        return this.authoritative;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setAuthoritative(Boolean authoritative) {
        this.authoritative = authoritative;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void write(XmlWriter writer) throws IOException {
        writer.writeStart(ADDRESS_FRBR_TRANSLATION, 15);
        writeLinkReq(writer, this);
        writeFromLanguage(writer, this);
        writeAgent(writer, this);
        writeAuthoritative(writer, this);
        writePivot(writer, this);
        super.write(writer);
        writer.writeEnd(ADDRESS_FRBR_TRANSLATION, 15);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String name() {
        return FRBR_TRANSLATION;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public ImmutableMap> attributes() {
        return ATTRIBUTES;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void accept(AknVisitor visitor) {
        visitor.visit(this);
    }

}