001/*
002 * (C) Copyright 2010 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Anahide Tchertchian
018 */
019package org.nuxeo.ecm.platform.query.core;
020
021import org.nuxeo.common.xmap.annotation.XNode;
022import org.nuxeo.common.xmap.annotation.XObject;
023import org.nuxeo.ecm.platform.query.api.PageProvider;
024import org.nuxeo.ecm.platform.query.api.PageProviderDefinition;
025
026/**
027 * Page provider descriptor accepting a custom class name. The expected interface is {@link ContentViewPageProvider},
028 * all other attributes are common to other page provider descriptors.
029 *
030 * @author Anahide Tchertchian
031 * @since 5.4
032 */
033@XObject("genericPageProvider")
034public class GenericPageProviderDescriptor extends BasePageProviderDescriptor implements PageProviderDefinition {
035
036    private static final long serialVersionUID = 1L;
037
038    @XNode("@class")
039    protected Class<PageProvider<?>> klass;
040
041    public Class<PageProvider<?>> getPageProviderClass() {
042        return klass;
043    }
044
045    @Override
046    protected BasePageProviderDescriptor newInstance() {
047        return new GenericPageProviderDescriptor();
048    }
049
050    @Override
051    public GenericPageProviderDescriptor clone() {
052        GenericPageProviderDescriptor clone = (GenericPageProviderDescriptor) super.cloneDescriptor();
053        clone.klass = getPageProviderClass();
054        return clone;
055    }
056
057}