com.enonic.xp.query.highlight.HighlightQueryProperty Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-api Show documentation
core-api
The newest version!
package com.enonic.xp.query.highlight;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;

import com.enonic.xp.query.highlight.constants.Fragmenter;
import com.enonic.xp.query.highlight.constants.Order;

public class HighlightQueryProperty
{
    private final String name;

    private final HighlightPropertySettings settings;

    private HighlightQueryProperty( final Builder builder )
    {
        this.name = builder.name;
        this.settings = builder.settings;
    }

    public static Builder create( final String name )
    {
        return new Builder( name );
    }

    private HighlightPropertySettings doGetSettings() {
        return settings;
    }

    public String getName()
    {
        return name;
    }

    public Fragmenter getFragmenter()
    {
        return doGetSettings().getFragmenter();
    }

    public Integer getFragmentSize()
    {
        return doGetSettings().getFragmentSize();
    }

    public Integer getNoMatchSize()
    {
        return doGetSettings().getNoMatchSize();
    }

    public Integer getNumOfFragments()
    {
        return doGetSettings().getNumOfFragments();
    }

    public Order getOrder()
    {
        return doGetSettings().getOrder();
    }

    public ImmutableList getPreTags()
    {
        return doGetSettings().getPreTags();
    }

    public ImmutableList getPostTags()
    {
        return doGetSettings().getPostTags();
    }

    public Boolean getRequireFieldMatch()
    {
        return doGetSettings().getRequireFieldMatch();
    }

    public static class Builder
    {
        private final String name;

        private HighlightPropertySettings settings = HighlightPropertySettings.empty();

        public Builder( final String name )
        {
            this.name = name;
        }

        public Builder settings( final HighlightPropertySettings settings )
        {
            this.settings = settings;
            return this;
        }

        private void validate()
        {
            Preconditions.checkNotNull( name, "name is required" );
        }

        public HighlightQueryProperty build()
        {
            validate();
            return new HighlightQueryProperty( this );
        }
    }
}