net.sf.dynamicreports.report.builder.HyperLinkBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of dynamicreports-core Show documentation
DynamicReports is an open source Java reporting library based on JasperReports. It allows to create dynamic report designs and it doesn't need a visual report designer. You can very quickly create reports and produce documents that can be displayed, printed or exported into many popular formats such as PDF, Excel, Word and others.
There is a newer version: 6.20.1
Show newest version
/*
 * DynamicReports - Free Java reporting library for creating reports dynamically
 *
 * Copyright (C) 2010 - 2018 Ricardo Mariaca and the Dynamic Reports Contributors
 * http://www.dynamicreports.org
 *
 * This file is part of DynamicReports.
 *
 * DynamicReports is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * DynamicReports is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with DynamicReports. If not, see .
 */
package net.sf.dynamicreports.report.builder;

import net.sf.dynamicreports.report.base.DRHyperLink;
import net.sf.dynamicreports.report.builder.expression.Expressions;
import net.sf.dynamicreports.report.constant.Constants;
import net.sf.dynamicreports.report.constant.HyperLinkTarget;
import net.sf.dynamicreports.report.constant.HyperLinkType;
import net.sf.dynamicreports.report.definition.expression.DRIExpression;
import org.apache.commons.lang3.Validate;

/**
 * HyperLinkBuilder class.
 *
 * @author Ricardo Mariaca ([email protected])
 * @version $Id: $Id
 */
public class HyperLinkBuilder extends AbstractBuilder {
    private static final long serialVersionUID = Constants.SERIAL_VERSION_UID;

    /**
     * Constructor for HyperLinkBuilder.
     */
    protected HyperLinkBuilder() {
        super(new DRHyperLink());
    }

    /**
     * Constructor for HyperLinkBuilder.
     *
     * @param link a {@link java.lang.String} object.
     */
    protected HyperLinkBuilder(String link) {
        super(new DRHyperLink());
        setLink(link);
    }

    /**
     * Constructor for HyperLinkBuilder.
     *
     * @param linkExpression a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
     */
    protected HyperLinkBuilder(DRIExpression linkExpression) {
        super(new DRHyperLink());
        setLink(linkExpression);
    }

    /**
     * setLink.
     *
     * @param link a {@link java.lang.String} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setLink(String link) {
        Validate.notNull(link, "link must not be null");
        return setLink(Expressions.text(link));
    }

    /**
     * setLink.
     *
     * @param linkExpression a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setLink(DRIExpression linkExpression) {
        Validate.notNull(linkExpression, "linkExpression must not be null");
        getObject().setReferenceExpression(linkExpression);
        getObject().setType(HyperLinkType.REFERENCE.name());
        return this;
    }

    /**
     * setAnchor.
     *
     * @param anchor a {@link java.lang.String} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setAnchor(String anchor) {
        getObject().setAnchorExpression(Expressions.text(anchor));
        return this;
    }

    /**
     * setAnchor.
     *
     * @param anchorExpression a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setAnchor(DRIExpression anchorExpression) {
        getObject().setAnchorExpression(anchorExpression);
        return this;
    }

    /**
     * setPage.
     *
     * @param page a {@link java.lang.Integer} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setPage(Integer page) {
        getObject().setPageExpression(Expressions.value(page));
        return this;
    }

    /**
     * setPage.
     *
     * @param pageExpression a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setPage(DRIExpression pageExpression) {
        getObject().setPageExpression(pageExpression);
        return this;
    }

    /**
     * setReference.
     *
     * @param reference a {@link java.lang.String} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setReference(String reference) {
        getObject().setReferenceExpression(Expressions.text(reference));
        return this;
    }

    /**
     * setReference.
     *
     * @param referenceExpression a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setReference(DRIExpression referenceExpression) {
        getObject().setReferenceExpression(referenceExpression);
        return this;
    }

    /**
     * setTooltip.
     *
     * @param tooltip a {@link java.lang.String} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setTooltip(String tooltip) {
        getObject().setTooltipExpression(Expressions.text(tooltip));
        return this;
    }

    /**
     * setTooltip.
     *
     * @param tooltipExpression a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setTooltip(DRIExpression tooltipExpression) {
        getObject().setTooltipExpression(tooltipExpression);
        return this;
    }

    /**
     * setType.
     *
     * @param hyperLinkType a {@link net.sf.dynamicreports.report.constant.HyperLinkType} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setType(HyperLinkType hyperLinkType) {
        getObject().setType(hyperLinkType.name());
        return this;
    }

    /**
     * setType.
     *
     * @param hyperLinkType a {@link java.lang.String} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setType(String hyperLinkType) {
        getObject().setType(hyperLinkType);
        return this;
    }

    /**
     * setTarget.
     *
     * @param hyperLinkTarget a {@link net.sf.dynamicreports.report.constant.HyperLinkTarget} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setTarget(HyperLinkTarget hyperLinkTarget) {
        getObject().setTarget(hyperLinkTarget.name());
        return this;
    }

    /**
     * setTarget.
     *
     * @param hyperLinkTarget a {@link java.lang.String} object.
     * @return a {@link net.sf.dynamicreports.report.builder.HyperLinkBuilder} object.
     */
    public HyperLinkBuilder setTarget(String hyperLinkTarget) {
        getObject().setTarget(hyperLinkTarget);
        return this;
    }

    /**
     * getHyperLink.
     *
     * @return a {@link net.sf.dynamicreports.report.base.DRHyperLink} object.
     */
    public DRHyperLink getHyperLink() {
        return build();
    }
}