nl.vpro.domain.api.media.TitleFacetList Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-domain Show documentation

Contains the objects used by the Frontend API, like forms and result objects

There is a newer version: 8.3.3

package nl.vpro.domain.api.media;

import java.util.*;

import javax.validation.Valid;
import javax.xml.bind.annotation.*;

import org.checkerframework.checker.nullness.qual.NonNull;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

import nl.vpro.domain.api.SearchableFacet;
import nl.vpro.domain.api.jackson.media.TitleFacetListJson;

/**
 * @author Lies Kombrink
 * @since 5.5
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "mediaTitleFacetListType", propOrder = {"subSearch", "facets"})
@JsonSerialize(using = TitleFacetListJson.Serializer.class)
@JsonDeserialize(using = TitleFacetListJson.Deserializer.class)
public class TitleFacetList
    extends MediaFacet /* extending MediaFacet is mainly done for backwards compatibility */
    implements SearchableFacet, Iterable {

    @Valid
    private TitleSearch subSearch;

    @Valid
    @XmlElement(name = "title")
    protected List facets;

    public TitleFacetList() {
        super(null, null, null);
    }

    public boolean asMediaFacet() {
        return !(filter != null || subSearch != null || facets != null);
    }

    public TitleFacetList(List facets) {
        this.facets = facets;
    }

    @Override
    public TitleSearch getSubSearch() {
        return subSearch;
    }

    @Override
    public void setSubSearch(TitleSearch subSearch) {
        this.subSearch = subSearch;
    }

    /**
     * Use iterator if you want to initialise the facet names. Clients may supply there own custom name, but
     * this is optional
     */
    public List getFacets() {
        return facets;
    }

    public void setFacets(List facets) {
        this.facets = facets;
    }

    public boolean isEmpty() {
        return facets == null || facets.isEmpty();
    }

    public int size() {
        return facets == null ? 0 : facets.size();
    }


    @Override
    public boolean hasSubSearch() {
        return subSearch != null && subSearch.hasSearches();
    }

    @NonNull
    @Override
    public Iterator iterator() {
        return new Iterator() {
            private int index = 0;

            @Override
            public boolean hasNext() {
                return facets != null && index < facets.size();
            }

            @Override
            public TitleFacet next() {
                if (! hasNext()) {
                    throw new NoSuchElementException();
                }
                TitleFacet titleFacet = facets.get(index++);
                if (titleFacet.getName() == null) {
                    titleFacet.setName("titles" + index);
                }
                return titleFacet;
            }

            @Override
            public void remove() {
                throw new UnsupportedOperationException("Unsupported");
            }
        };
    }
}