chemistry/chemistry-api/src/main/java/org/apache/chemistry/CMIS.java

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Authors:
 *     Florent Guillaume, Nuxeo
 */
package org.apache.chemistry;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import javax.xml.namespace.QName;

/**
 * Utility class providing CMIS-related constants.
 */
public class CMIS {

    // utility class
    private CMIS() {
    }

    public static final String CMIS_NS_BASE = "http://docs.oasis-open.org/ns/cmis/";

    public static final String CMIS_NS = CMIS_NS_BASE + "core/200908/";

    public static final String CMIS_PREFIX = "cmis";

    public static QName CMISName(String localPart) {
        return new QName(CMIS_NS, localPart, CMIS_PREFIX);
    }

    public static final QName REPOSITORY_ID = CMISName("repositoryId");

    public static final QName REPOSITORY_NAME = CMISName("repositoryName");

    public static final QName REPOSITORY_DESCRIPTION = CMISName("repositoryDescription");

    public static final QName VENDOR_NAME = CMISName("vendorName");

    public static final QName PRODUCT_NAME = CMISName("productName");

    public static final QName PRODUCT_VERSION = CMISName("productVersion");

    public static final QName ROOT_FOLDER_ID = CMISName("rootFolderId");

    public static final QName LATEST_CHANGE_LOG_TOKEN = CMISName("latestChangeLogToken");

    public static final QName CHANGES_ON_TYPE = CMISName("changesOnType");

    public static final QName CAPABILITIES = CMISName("capabilities");

    public static final QName CAPABILITY_MULTIFILING = CMISName("capabilityMultifiling");

    public static final QName CAPABILITY_UNFILING = CMISName("capabilityUnfiling");

    public static final QName CAPABILITY_VERSION_SPECIFIC_FILING = CMISName("capabilityVersionSpecificFiling");

    public static final QName CAPABILITY_PWC_UPDATABLE = CMISName("capabilityPWCUpdatable");

    public static final QName CAPABILITY_PWC_SEARCHABLE = CMISName("capabilityPWCSearchable");

    public static final QName CAPABILITY_ALL_VERSIONS_SEARCHABLE = CMISName("capabilityAllVersionsSearchable");

    public static final QName CAPABILITY_CAN_GET_DESCENDANTS = CMISName("capabilityGetDescendants");

    public static final QName CAPABILITY_CAN_GET_FOLDER_TREE = CMISName("capabilityGetFolderTree");

    public static final QName CAPABILITY_CONTENT_STREAM_UPDATABILITY = CMISName("capabilityContentStreamUpdatability");

    public static final QName CAPABILITY_QUERY = CMISName("capabilityQuery");

    public static final QName CAPABILITY_JOIN = CMISName("capabilityJoin");

    public static final QName CAPABILITY_RENDITIONS = CMISName("capabilityRenditions");

    public static final QName CAPABILITY_CHANGES = CMISName("capabilityChanges");

    public static final QName CAPABILITY_ACL = CMISName("capabilityACL");

    public static final QName CHANGES_INCOMPLETE = CMISName("changesIncomplete");

    public static final QName ACL_CAPABILITY = CMISName("aclCapability");

    public static final QName SET_TYPE = CMISName("setType");

    public static final QName PERMISSIONS = CMISName("permissions");

    public static final QName MAPPING = CMISName("mapping");

    public static final QName KEY = CMISName("key");

    public static final QName PERMISSION = CMISName("permission");

    public static final QName VERSION_SUPPORTED = CMISName("cmisVersionSupported");

    public static final QName THIN_CLIENT_URI = CMISName("thinClientURI");

    public static final QName REPOSITORY_SPECIFIC_INFORMATION = CMISName("repositorySpecificInformation");

    public static final QName BASE_ID = CMISName("baseId");

    public static final QName ID = CMISName("id");

    public static final QName LOCAL_NAME = CMISName("localName");

    public static final QName LOCAL_NAMESPACE = CMISName("localNamespace");

    public static final QName QUERY_NAME = CMISName("queryName");

    public static final QName DISPLAY_NAME = CMISName("displayName");

    public static final QName PARENT_ID = CMISName("parentId");

    public static final QName DESCRIPTION = CMISName("description");

    public static final QName CREATABLE = CMISName("creatable");

    public static final QName FILEABLE = CMISName("fileable");

    public static final QName QUERYABLE = CMISName("queryable");

    public static final QName CONTROLLABLE_POLICY = CMISName("controllablePolicy");

    public static final QName CONTROLLABLE_ACL = CMISName("controllableACL");

    public static final QName FULLTEXT_INDEXED = CMISName("fulltextIndexed");

    public static final QName VERSIONABLE = CMISName("versionable");

    public static final QName CONTENT_STREAM_ALLOWED = CMISName("contentStreamAllowed");

    public static final QName INCLUDED_IN_SUPERTYPE_QUERY = CMISName("includedInSupertypeQuery");

    public static final QName PROPERTY_STRING_DEFINITION = CMISName("propertyStringDefinition");

    public static final QName PROPERTY_DECIMAL_DEFINITION = CMISName("propertyDecimalDefinition");

    public static final QName PROPERTY_INTEGER_DEFINITION = CMISName("propertyIntegerDefinition");

    public static final QName PROPERTY_BOOLEAN_DEFINITION = CMISName("propertyBooleanDefinition");

    public static final QName PROPERTY_DATETIME_DEFINITION = CMISName("propertyDateTimeDefinition");

    public static final QName PROPERTY_URI_DEFINITION = CMISName("propertyUriDefinition");

    public static final QName PROPERTY_ID_DEFINITION = CMISName("propertyIdDefinition");

    public static final QName PROPERTY_HTML_DEFINITION = CMISName("propertyHtmlDefinition");

    public static final QName PROPERTY_TYPE = CMISName("propertyType");

    public static final QName CARDINALITY = CMISName("cardinality");

    public static final QName UPDATABILITY = CMISName("updatability");

    public static final QName INHERITED = CMISName("inherited");

    public static final QName REQUIRED = CMISName("required");

    public static final QName ORDERABLE = CMISName("orderable");

    public static final QName DEFAULT_VALUE = CMISName("defaultValue");

    public static final QName PROPERTIES = CMISName("properties");

    public static final QName PROPERTY_STRING = CMISName("propertyString");

    public static final QName PROPERTY_DECIMAL = CMISName("propertyDecimal");

    public static final QName PROPERTY_INTEGER = CMISName("propertyInteger");

    public static final QName PROPERTY_BOOLEAN = CMISName("propertyBoolean");

    public static final QName PROPERTY_DATETIME = CMISName("propertyDateTime");

    public static final QName PROPERTY_URI = CMISName("propertyUri");

    public static final QName PROPERTY_ID = CMISName("propertyId");

    public static final QName PROPERTY_XML = CMISName("propertyXml");

    public static final QName PROPERTY_HTML = CMISName("propertyHtml");

    public static final QName VALUE = CMISName("value");

    public static final QName ALLOWABLE_ACTIONS = CMISName("allowableActions");

    public static final QName CHANGE_EVENT_INFO = CMISName("changeEventInfo");

    public static final QName CHANGE_TYPE = CMISName("changeType");

    public static final QName CHANGE_TIME = CMISName("changeTime");

    public static final QName QUERY = CMISName("query");

    public static final QName STATEMENT = CMISName("statement");

    public static final QName SEARCH_ALL_VERSIONS = CMISName("searchAllVersions");

    public static final QName INCLUDE_ALLOWABLE_ACTIONS = CMISName("includeAllowableActions");

    public static final QName INCLUDE_RELATIONSHIPS = CMISName("includeRelationships");

    public static final QName INCLUDE_POLICY_IDS = CMISName("includePolicyIds");

    public static final QName INCLUDE_ACL = CMISName("includeACL");

    public static final QName RENDITION_FILTER = CMISName("renditionFilter");

    public static final QName MAX_ITEMS = CMISName("maxItems");

    public static final QName SKIP_COUNT = CMISName("skipCount");

    // no namespace for attributes

    public static final QName PDID = new QName("propertyDefinitionId");

    public static final QName LOCAL_NAME_NONS = new QName("localName");

    public static final QName QUERY_NAME_NONS = new QName("queryName");

    public static final QName DISPLAY_NAME_NONS = new QName("displayName");

    // types from schema

    public static final QName SCHEMA_TYPE_DOCUMENT = CMISName("cmisTypeDocumentDefinitionType");

    public static final QName SCHEMA_TYPE_FOLDER = CMISName("cmisTypeFolderDefinitionType");

    public static final QName SCHEMA_TYPE_RELATIONSHIP = CMISName("cmisTypeRelationshipDefinitionType");

    public static final QName SCHEMA_TYPE_POLICY = CMISName("cmisTypePolicyDefinitionType");

    public static final Map<BaseType, QName> SCHEMA_TYPES;

    static {
        Map<BaseType, QName> map = new HashMap<BaseType, QName>();
        map.put(BaseType.DOCUMENT, SCHEMA_TYPE_DOCUMENT);
        map.put(BaseType.FOLDER, SCHEMA_TYPE_FOLDER);
        map.put(BaseType.RELATIONSHIP, SCHEMA_TYPE_RELATIONSHIP);
        map.put(BaseType.POLICY, SCHEMA_TYPE_POLICY);
        SCHEMA_TYPES = Collections.unmodifiableMap(map);
    }
}