David Caruana 8fcebdc7cf CMIS Dictionary Refactor
- follows pattern of Alfresco Dictionary
- simplified and much reduced DictionaryService interface
- model now compiled and cached (no more lots of small continuous object creations)
- walk model via simple getters
- validated (no dangling references)
- fix up property inheritance
- fix up sub-types for all types
- implements strict mode only for now (i.e. doesn't go outside of CMIS doc, folder, rel and policy)
- abstract helper for building other CMIS dictionaries (e.g. mapping all types in Alfresco)

Alfresco Dictionary:
- add event for initialized or re-initialized

Fix up usage in CMIS REST, Web Services and query. Tests pass.

REST support for custom sub-types and properties now reliable as constrained by validated CMIS model.

TODO:
- hook property value accessors into CMIS Dictionary

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@13768 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2009-03-27 23:13:29 +00:00

122 lines
3.5 KiB
Java

/*
* Copyright (C) 2005-2007 Alfresco Software Limited.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* As a special exception to the terms and conditions of version 2.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* and Open Source Software ("FLOSS") applications as described in Alfresco's
* FLOSS exception. You should have recieved a copy of the text describing
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing"
*/
package org.alfresco.cmis.dictionary;
import java.util.Collection;
import org.alfresco.cmis.CMISDataTypeEnum;
import org.alfresco.service.namespace.QName;
/**
* Service to query the CMIS meta model
*
* @author davidc
*/
public interface CMISDictionaryService
{
/**
* Get Type Id
*
* @param typeId
* @return
*/
public CMISTypeId getTypeId(String typeId);
/**
* Get Type Id from Table Name
*
* @param table
* @return
*/
public CMISTypeId getTypeIdFromTable(String table);
/**
* Get Type Id from Alfresco Class Name
*
* @param clazz
* @param matchingScope if provided, only return type id matching scope
* @return
*/
public CMISTypeId getTypeId(QName clazz, CMISScope matchingScope);
/**
* Get Type Definition
*
* @param typeId
* @return
*/
public CMISTypeDefinition getType(CMISTypeId typeId);
/**
* Get All Type Definitions
*
* @return
*/
public Collection<CMISTypeDefinition> getAllTypes();
/**
* Get Property Id for Alfresco property name
*
* @param property
* @return
*/
public CMISPropertyId getPropertyId(QName property);
/**
* Get Property Id
*
* @param propertyId
* @return
*/
public CMISPropertyId getPropertyId(String propertyId);
/**
* Get Property
*
* @param propertyId
* @return
*/
public CMISPropertyDefinition getProperty(CMISPropertyId propertyId);
/**
* Get Data Type
*
* @param dataType
* @return
*/
public CMISDataTypeEnum getDataType(QName dataType);
// public CMISTypeDef findType(CMISTypeId typeId)
// public CMISTypeDef findType(String typeId)
// public CMISTypeDef findTypeForClass(QName clazz, CMISScope matchingScope, ...)
// public CMISTypeDef findTypeForTable(String tableName)
// public CMISTypeDef getAllTypes();
// public CMISPropertyDefinition getProperty(QName property)
// public CMISPropertyDefinition getProperty(CMISTypeDef typeDef, String property)
// public CMISDataTypeEnum getDataType(QName dataType)
}