001/*
002 * (C) Copyright 2006-2007 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 *     <a href="mailto:[email protected]">Anahide Tchertchian</a>
018 *
019 * $Id: IORelationAdapterProperties.java 25081 2007-09-18 14:57:22Z atchertchian $
020 */
021
022package org.nuxeo.ecm.platform.relations.io;
023
024import org.nuxeo.ecm.platform.relations.api.impl.RelationDate;
025
026/**
027 * Map of property names used by the relation adapter.
028 *
029 * @author <a href="mailto:[email protected]">Anahide Tchertchian</a>
030 */
031public class IORelationAdapterProperties {
032
033    /**
034     * Property representing the graph name where relations should be extracted.
035     */
036    public static final String GRAPH = "graph";
037
038    /**
039     * Property representing the graph name where relations should be imported.
040     * <p>
041     * Defaults to the graph property value.
042     */
043    public static final String IMPORT_GRAPH = "import-graph";
044
045    /**
046     * Property representing a boolean value that indicates if only internal relations must be kept when
047     * exporting/importing.
048     * <p>
049     * For instance, if a document tree is copied, we could chose to ignore relations pointing to documents outside of
050     * the copied tree.
051     * <p>
052     * Default value: false.
053     */
054    public static final String IGNORE_EXTERNAL = "ignore-external";
055
056    /**
057     * Property representing a boolean value that indicates if relations involving literals should be ignored when
058     * importing/exporting.
059     * <p>
060     * Default value: false.
061     */
062    public static final String IGNORE_LITERALS = "ignore-literals";
063
064    /**
065     * Property representing a boolean value that indicates if relations involving resources that are not QName
066     * resources should be ignored when importing/exporting.
067     * <p>
068     * Default value: false.
069     */
070    public static final String IGNORE_SIMPLE_RESOURCES = "ignore-simple-resources";
071
072    /**
073     * Property representing a list of predicates uris that should be filtered.
074     * <p>
075     * If list is not empty, relations using a predicate which is not on this list will not be kept.
076     */
077    public static final String FILTER_PREDICATES = "filter-predicates";
078
079    /**
080     * Property representing a list of predicates uris that should be ignored.
081     * <p>
082     * If list is not empty, relations using a predicate which is on this list will not be kept.
083     */
084    public static final String IGNORE_PREDICATES = "ignore-predicates";
085
086    /**
087     * Property representing a list of metadata uris that should be filtered.
088     * <p>
089     * If list is not empty, metadata (properties) for relations using a uri which is not on this list will not be kept.
090     */
091    public static final String FILTER_METADATA = "filter-metatada";
092
093    /**
094     * Property representing a list of metadata uris that should be ignored.
095     * <p>
096     * If list is not empty, metadata (properties) for relations using a uri which is on this list will not be kept.
097     */
098    public static final String IGNORE_METADATA = "ignore-metatada";
099
100    /**
101     * Property representing a boolean value that indicates if metadata should not be kept when exporting/importing.
102     * <p>
103     * Default value: false.
104     */
105    public static final String IGNORE_ALL_METADATA = "ignore-all-metatada";
106
107    /**
108     * Property representing a list of metadata uris that should be updated.
109     * <p>
110     * If list is not empty, metadata (properties) for relations using a uri which is on this list will be updated to
111     * match current date.
112     * <p>
113     * Current date is set as a literal as described in {@link RelationDate}
114     */
115    public static final String UPDATE_DATE_METADATA = "update-date-metatada";
116
117    // Constant utility class.
118    private IORelationAdapterProperties() {
119    }
120
121}