cz.vutbr.fit.layout.segm.BasicSegmProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fitlayout-segm-base Show documentation
FitLayout - Basic segmentation algorithm and area tree operators.
The newest version!
/**
 * Provider.java
 *
 * Created on 15. 1. 2015, 15:03:22 by burgetr
 */
package cz.vutbr.fit.layout.segm;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.rdf4j.model.IRI;

import cz.vutbr.fit.layout.api.Parameter;
import cz.vutbr.fit.layout.api.ServiceException;
import cz.vutbr.fit.layout.impl.BaseArtifactService;
import cz.vutbr.fit.layout.impl.ParameterBoolean;
import cz.vutbr.fit.layout.model.AreaTree;
import cz.vutbr.fit.layout.model.Artifact;
import cz.vutbr.fit.layout.model.Page;
import cz.vutbr.fit.layout.ontology.BOX;
import cz.vutbr.fit.layout.ontology.SEGM;

/**
 * An artifact service provider for transforming the box tree to the area tree. It implements a basic
 * algorithm that only selects the visually separated boxes as the areas.
 * 
 * @author burgetr
 */
public class BasicSegmProvider extends BaseArtifactService
{
    /** Preserve the auxiliary areas that have no visual impact */
    private boolean preserveAuxAreas;
    
    
    public BasicSegmProvider()
    {
        this.preserveAuxAreas = false;
    }
    
    public BasicSegmProvider(boolean presereAuxAreas)
    {
        this.preserveAuxAreas = presereAuxAreas;
    }

    @Override
    public String getId()
    {
        return "FitLayout.BasicAreas";
    }

    @Override
    public String getName()
    {
        return "Simple area tree construction";
    }

    @Override
    public String getDescription()
    {
        return "Creates a basic area tree by simply taking all visually separated boxes and creating"
                + " visual areas from them.";
    }

    @Override
    public IRI getConsumes()
    {
        return BOX.Page;
    }

    @Override
    public IRI getProduces()
    {
        return SEGM.AreaTree;
    }

    @Override
    public Artifact process(Artifact input) throws ServiceException
    {
        if (input != null && input instanceof Page)
        {
            AreaTree atree = createAreaTree((Page) input);
            IRI atreeIri = getServiceManager().getArtifactRepository().createArtifactIri(atree);
            atree.setIri(atreeIri);
            return atree;
        }
        else
            throw new ServiceException("Source artifact not specified or not a page");
    }

    public AreaTree createAreaTree(Page page)
    {
        SegmentationAreaTree atree = new SegmentationAreaTree(page, preserveAuxAreas);
        atree.findBasicAreas();
        atree.setParentIri(page.getIri());
        atree.setLabel(getId());
        atree.setCreator(getId());
        atree.setCreatorParams(getParamString());
        return atree; 
    }

    @Override
    public List defineParams()
    {
        List ret = new ArrayList<>(1);
        ret.add(new ParameterBoolean("preserveAuxAreas"));
        return ret;
    }
    
    public boolean getPreserveAuxAreas()
    {
        return preserveAuxAreas;
    }

    public void setPreserveAuxAreas(boolean preserveAuxAreas)
    {
        this.preserveAuxAreas = preserveAuxAreas;
    }

}