com.wewebu.ow.server.ecmimpl.opencmis.alfresco

Class OwCMISAbstractAlfrescoClass<T extends org.apache.chemistry.opencmis.client.api.ObjectType,O extends org.apache.chemistry.opencmis.client.api.TransientCmisObject>

java.lang.Object

com.wewebu.ow.server.ecmimpl.opencmis.objectclass.OwCMISAbstractObjectClass

com.wewebu.ow.server.ecmimpl.opencmis.alfresco.OwCMISAbstractAlfrescoClass<T,O>

All Implemented Interfaces:

com.wewebu.ow.server.ecm.OwObjectClass, OwCMISNativeObjectClass<T,O>, OwCMISObjectClass, OwCMISSessionObjectClass<OwCMISNativeSession>

Direct Known Subclasses:

OwCMISAbstractAlfrescoObjectClass, OwCMISAlfrescoTypeClassImpl

public abstract class OwCMISAbstractAlfrescoClass<T extends org.apache.chemistry.opencmis.client.api.ObjectType,O extends org.apache.chemistry.opencmis.client.api.TransientCmisObject>
extends OwCMISAbstractObjectClass
implements OwCMISNativeObjectClass<T,O>

OwCMISAbstractAlfrescoClass.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Field Summary

Fields inherited from interface com.wewebu.ow.server.ecmimpl.opencmis.objectclass.OwCMISObjectClass

MIME_TYPE_PREFIX_OW_POLICY, MIME_TYPE_PREFIX_OW_RELATIONSHIP

Fields inherited from interface com.wewebu.ow.server.ecm.OwObjectClass

OPERATION_TYPE_CHECKIN, OPERATION_TYPE_CHECKOUT, OPERATION_TYPE_CREATE_NEW_OBJECT, OPERATION_TYPE_SET_PROPERTIES, OPERATION_TYPE_UNDEF

Constructor Summary

Constructors

Constructor and Description
OwCMISAbstractAlfrescoClass(OwCMISNativeObjectClass<T,O> nativeObjectClass)

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,?>	addClassParameter(Map<String,?> conversionParameters)
protected abstract boolean	areAspectsSecured()
boolean	canCreateNewObject()
Map<String,Object>	convertToNativeProperties(com.wewebu.ow.server.ecm.OwPropertyCollection properties_p) AWD Property collections converter method.
protected org.apache.chemistry.opencmis.client.api.OperationContext	createContext(Map<String,?> conversionParameters) Helper for handling OpenCMIS OperationContext.
String	createNewObject(boolean promote_p, Object mode_p, com.wewebu.ow.server.ecm.OwPropertyCollection properties_p, com.wewebu.ow.server.ecm.OwPermissionCollection permissions_p, com.wewebu.ow.server.ecm.OwContentCollection content_p, com.wewebu.ow.server.ecm.OwObject parent_p, String strMimeType_p, String strMimeParameter_p, boolean keepCheckedOut_p) Creates a new object with specific definition, will return the native ID of created object not a DMSID.
com.wewebu.ow.server.ecm.OwObjectSkeleton	createSkeletonObject(com.wewebu.ow.server.ecm.OwNetwork network_p, OwCMISResource res_p, OwCMISNativeSession ses_p, com.wewebu.ow.server.util.OwXMLUtil initValues_p) Create skeleton Object for this specific object class.
protected OwCMISPropertyClass<?>	findAspectsPropertyClass(String className, boolean secure)
OwCMISPropertyClass<?>	findPropertyClass(String className)
protected abstract Collection<OwCMISNativeObjectClass<?,?>>	getAspectsClasses(boolean secure)
protected OwCMISNativePropertyClass<?,?,org.apache.chemistry.opencmis.commons.definitions.PropertyDefinition<?>>	getAspectsNativePropertyClass(String className, boolean secure)
protected Map<String,OwCMISNativePropertyClass<?,?,?>>	getAspectsNativePropertyClasses(boolean localOnly)
protected Map<String,OwCMISPropertyClass<?>>	getAspectsPropertyClasses()
Map<String,OwCMISObjectClass>	getChildNames(com.wewebu.ow.server.ecm.OwNetwork network_p, boolean fExcludeHiddenAndNonInstantiable_p)
List<OwCMISObjectClass>	getChilds(com.wewebu.ow.server.ecm.OwNetwork network_p, boolean fExcludeHiddenAndNonInstantiable_p)
String	getClassName()
String	getCopyClassName() Return the class name which is unique and define fully the new type/class of a copy instance.
String	getDescription(Locale locale_p)
String	getDisplayName(Locale locale_p)
String	getMimetype()
List<?>	getModes(int operation_p)
String	getNamePropertyName()
T	getNativeObject()
protected OwCMISNativeObjectClass<T,O>	getNativeObjectClass()
OwCMISNativePropertyClass<?,?,org.apache.chemistry.opencmis.commons.definitions.PropertyDefinition<?>>	getNativePropertyClass(String className)
Map<String,OwCMISNativePropertyClass<? extends Object,?,?>>	getNativePropertyClasses(boolean localOnly)
OwCMISNativeObjectClass<T,O>	getParent()
OwCMISPreferredPropertyTypeCfg.PropertyType	getPreferredPropertyType(OwCMISPropertyClass<?> propertyClass)
Map<String,OwCMISPropertyClass<?>>	getPropertyClasses()
Set<OwCMISPropertyClass<?>>	getQueryablePropertyClasses()
String	getQueryName() Should return an non-null value if this object is query able.
OwCMISQueryResultConverter<O>	getQueryResultConverter(org.apache.chemistry.opencmis.client.api.QueryResult queryResult, com.wewebu.ow.csqlc.ast.OwQueryStatement statement, org.apache.chemistry.opencmis.client.api.OperationContext context)
OwCMISNativeSession	getSession()
int	getType()
OwCMISVirtualPropertyClass<?>	getVirtualPropertyClass(String strClassName_p)
Map<String,OwCMISVirtualPropertyClass<?>>	getVirtualPropertyClasses(boolean localOnly_p)
boolean	hasChilds(com.wewebu.ow.server.ecm.OwNetwork network_p, boolean fExcludeHiddenAndNonInstantiable_p, int context_p)
boolean	hasVersionSeries()
boolean	isAssignableFrom(OwCMISObjectClass class_p) A java class analogous method : Determines if the object-class represented by this object-class object is either the same as, or is a superclass of the object-class represented by the specified object-class parameter.
boolean	isContentRequired() Define if for this object the content is required.
boolean	isHidden()
boolean	isQueryable() As specified by the CMIS definition, the request method to verify if this object can be used in query FROM statement.
<N extends org.apache.chemistry.opencmis.client.api.TransientCmisObject> OwCMISTransientObject<N>	newTransientObject(N cmisObject, org.apache.chemistry.opencmis.client.api.OperationContext creationContext)
void	subclassedBy(OwCMISObjectClass subclass_p) Method called when this class is sub-classed.

Methods inherited from class com.wewebu.ow.server.ecmimpl.opencmis.objectclass.OwCMISAbstractObjectClass

addVirtualPropertyClass, getParameterValue, getPropertyClass, getPropertyClassNames, initializeAsHierarchyRoot

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.wewebu.ow.server.ecmimpl.opencmis.objectclass.OwCMISNativeObjectClass

from

Methods inherited from interface com.wewebu.ow.server.ecmimpl.opencmis.objectclass.OwCMISObjectClass

getPropertyClass, getPropertyClassNames

Constructor Detail

OwCMISAbstractAlfrescoClass

public OwCMISAbstractAlfrescoClass(OwCMISNativeObjectClass<T,O> nativeObjectClass)

Method Detail

getAspectsClasses

protected abstract Collection<OwCMISNativeObjectClass<?,?>> getAspectsClasses(boolean secure)
                                                                       throws com.wewebu.ow.server.exceptions.OwException

Throws:

com.wewebu.ow.server.exceptions.OwException

areAspectsSecured

protected abstract boolean areAspectsSecured()

addClassParameter

protected Map<String,?> addClassParameter(Map<String,?> conversionParameters)

getAspectsNativePropertyClass

protected OwCMISNativePropertyClass<?,?,org.apache.chemistry.opencmis.commons.definitions.PropertyDefinition<?>> getAspectsNativePropertyClass(String className,
                                                                                                                                   boolean secure)

findAspectsPropertyClass

protected OwCMISPropertyClass<?> findAspectsPropertyClass(String className,
                                              boolean secure)
                                                   throws com.wewebu.ow.server.exceptions.OwException

Throws:

com.wewebu.ow.server.exceptions.OwException

getAspectsPropertyClasses

protected Map<String,OwCMISPropertyClass<?>> getAspectsPropertyClasses()
                                                                throws com.wewebu.ow.server.exceptions.OwException

Throws:

com.wewebu.ow.server.exceptions.OwException

getAspectsNativePropertyClasses

protected Map<String,OwCMISNativePropertyClass<?,?,?>> getAspectsNativePropertyClasses(boolean localOnly)
                                                                                throws com.wewebu.ow.server.exceptions.OwException

Throws:

com.wewebu.ow.server.exceptions.OwException

getPropertyClasses

public Map<String,OwCMISPropertyClass<?>> getPropertyClasses()
                                                      throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getPropertyClasses in interface OwCMISObjectClass

Overrides:

getPropertyClasses in class OwCMISAbstractObjectClass

Returns:

a Map of property classes fully qualified names mapped to OwCMISPropertyClass for all properties defined by this object class (inherited properties included).

Throws:

com.wewebu.ow.server.exceptions.OwException

getQueryablePropertyClasses

public Set<OwCMISPropertyClass<?>> getQueryablePropertyClasses()
                                                        throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getQueryablePropertyClasses in interface OwCMISObjectClass

Overrides:

getQueryablePropertyClasses in class OwCMISAbstractObjectClass

Returns:

a Set of OwCMISPropertyClass for all queryable property classes that are defined by this object class

Throws:

com.wewebu.ow.server.exceptions.OwException

findPropertyClass

public OwCMISPropertyClass<?> findPropertyClass(String className)

Specified by:

findPropertyClass in interface OwCMISObjectClass

Overrides:

findPropertyClass in class OwCMISAbstractObjectClass

getNativeObjectClass

protected OwCMISNativeObjectClass<T,O> getNativeObjectClass()

getNativeObject

public T getNativeObject()

Specified by:

getNativeObject in interface OwCMISNativeObjectClass<T extends org.apache.chemistry.opencmis.client.api.ObjectType,O extends org.apache.chemistry.opencmis.client.api.TransientCmisObject>

getNativePropertyClasses

public Map<String,OwCMISNativePropertyClass<? extends Object,?,?>> getNativePropertyClasses(boolean localOnly)
                                                                                     throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getNativePropertyClasses in interface OwCMISNativeObjectClass<T extends org.apache.chemistry.opencmis.client.api.ObjectType,O extends org.apache.chemistry.opencmis.client.api.TransientCmisObject>

Returns:

a Map of all native property classes defined by this class hierarchy. Ancestors defined properties are included only if localOnly is false.

Throws:

com.wewebu.ow.server.exceptions.OwException

getNativePropertyClass

public OwCMISNativePropertyClass<?,?,org.apache.chemistry.opencmis.commons.definitions.PropertyDefinition<?>> getNativePropertyClass(String className)

Specified by:

getNativePropertyClass in interface OwCMISNativeObjectClass<T extends org.apache.chemistry.opencmis.client.api.ObjectType,O extends org.apache.chemistry.opencmis.client.api.TransientCmisObject>

Parameters:

className - name of the native property class to be returned

Returns:

the requested native property class that contained by object class definition. null if no native property with the given name is defined.

getParent

public OwCMISNativeObjectClass<T,O> getParent()

Specified by:

getParent in interface com.wewebu.ow.server.ecm.OwObjectClass

Specified by:

getParent in interface OwCMISNativeObjectClass<T extends org.apache.chemistry.opencmis.client.api.ObjectType,O extends org.apache.chemistry.opencmis.client.api.TransientCmisObject>

Specified by:

getParent in interface OwCMISObjectClass

getSession

public OwCMISNativeSession getSession()

Specified by:

getSession in interface OwCMISNativeObjectClass<T extends org.apache.chemistry.opencmis.client.api.ObjectType,O extends org.apache.chemistry.opencmis.client.api.TransientCmisObject>

Specified by:

getSession in interface OwCMISSessionObjectClass<OwCMISNativeSession>

getType

public int getType()

Specified by:

getType in interface com.wewebu.ow.server.ecm.OwObjectClass

getMimetype

public String getMimetype()

Specified by:

getMimetype in interface OwCMISObjectClass

Returns:

the object class defined MIME type.

getVirtualPropertyClasses

public Map<String,OwCMISVirtualPropertyClass<?>> getVirtualPropertyClasses(boolean localOnly_p)

Specified by:

getVirtualPropertyClasses in interface OwCMISObjectClass

Overrides:

getVirtualPropertyClasses in class OwCMISAbstractObjectClass

getVirtualPropertyClass

public OwCMISVirtualPropertyClass<?> getVirtualPropertyClass(String strClassName_p)

Specified by:

getVirtualPropertyClass in interface OwCMISObjectClass

Overrides:

getVirtualPropertyClass in class OwCMISAbstractObjectClass

convertToNativeProperties

public Map<String,Object> convertToNativeProperties(com.wewebu.ow.server.ecm.OwPropertyCollection properties_p)
                                             throws com.wewebu.ow.server.exceptions.OwException

Description copied from interface: OwCMISNativeObjectClass

AWD Property collections converter method.

Specified by:

convertToNativeProperties in interface OwCMISNativeObjectClass<T extends org.apache.chemistry.opencmis.client.api.ObjectType,O extends org.apache.chemistry.opencmis.client.api.TransientCmisObject>

Returns:

converts the given AWD property collection to a Map of native property IDs mapped to their native values.

Throws:

com.wewebu.ow.server.exceptions.OwException

getChilds

public List<OwCMISObjectClass> getChilds(com.wewebu.ow.server.ecm.OwNetwork network_p,
                                boolean fExcludeHiddenAndNonInstantiable_p)
                                  throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getChilds in interface com.wewebu.ow.server.ecm.OwObjectClass

Specified by:

getChilds in interface OwCMISObjectClass

Overrides:

getChilds in class OwCMISAbstractObjectClass

Throws:

com.wewebu.ow.server.exceptions.OwException

getChildNames

public Map<String,OwCMISObjectClass> getChildNames(com.wewebu.ow.server.ecm.OwNetwork network_p,
                                          boolean fExcludeHiddenAndNonInstantiable_p)
                                            throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getChildNames in interface com.wewebu.ow.server.ecm.OwObjectClass

Specified by:

getChildNames in interface OwCMISObjectClass

Overrides:

getChildNames in class OwCMISAbstractObjectClass

Throws:

com.wewebu.ow.server.exceptions.OwException

isContentRequired

public boolean isContentRequired()
                          throws com.wewebu.ow.server.exceptions.OwException

Description copied from interface: OwCMISObjectClass

Define if for this object the content is required.

Specified by:

isContentRequired in interface OwCMISObjectClass

Overrides:

isContentRequired in class OwCMISAbstractObjectClass

Returns:

boolean true if is required, otherwise false

Throws:

com.wewebu.ow.server.exceptions.OwException

hasChilds

public boolean hasChilds(com.wewebu.ow.server.ecm.OwNetwork network_p,
                boolean fExcludeHiddenAndNonInstantiable_p,
                int context_p)
                  throws Exception

Specified by:

hasChilds in interface com.wewebu.ow.server.ecm.OwObjectClass

Overrides:

hasChilds in class OwCMISAbstractObjectClass

Throws:

Exception

isQueryable

public boolean isQueryable()

Description copied from interface: OwCMISObjectClass

As specified by the CMIS definition, the request method to verify if this object can be used in query FROM statement.

Specified by:

isQueryable in interface OwCMISObjectClass

Overrides:

isQueryable in class OwCMISAbstractObjectClass

Returns:

boolean query able

getQueryName

public String getQueryName()

Description copied from interface: OwCMISObjectClass

Should return an non-null value if this object is query able.

Specified by:

getQueryName in interface OwCMISObjectClass

Overrides:

getQueryName in class OwCMISAbstractObjectClass

Returns:

String escaped query name, which MUST be used for searches

createNewObject

public String createNewObject(boolean promote_p,
                     Object mode_p,
                     com.wewebu.ow.server.ecm.OwPropertyCollection properties_p,
                     com.wewebu.ow.server.ecm.OwPermissionCollection permissions_p,
                     com.wewebu.ow.server.ecm.OwContentCollection content_p,
                     com.wewebu.ow.server.ecm.OwObject parent_p,
                     String strMimeType_p,
                     String strMimeParameter_p,
                     boolean keepCheckedOut_p)
                       throws com.wewebu.ow.server.exceptions.OwException

Description copied from interface: OwCMISObjectClass

Creates a new object with specific definition, will return the native ID of created object not a DMSID.

Specified by:

createNewObject in interface OwCMISObjectClass

Overrides:

createNewObject in class OwCMISAbstractObjectClass

Parameters:

promote_p - boolean Major/Minor

mode_p - Object native mode (may not be supported and can be null)

properties_p - OwPropertyCollection defined properties for new object

permissions_p - OwPermissionCollection (if available, can be null)

content_p - OwContentCollection (can be null)

parent_p - OwObject (null if no parent needed)

strMimeType_p - String MIME type to be used

strMimeParameter_p - String MIME parameter

keepCheckedOut_p - boolean flag to create checked out

Returns:

a String ID for the newly created object (native ID)

Throws:

com.wewebu.ow.server.exceptions.OwException

getClassName

public String getClassName()

Specified by:

getClassName in interface com.wewebu.ow.server.ecm.OwObjectClass

getDisplayName

public String getDisplayName(Locale locale_p)

Specified by:

getDisplayName in interface com.wewebu.ow.server.ecm.OwObjectClass

getNamePropertyName

public String getNamePropertyName()
                           throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getNamePropertyName in interface com.wewebu.ow.server.ecm.OwObjectClass

Specified by:

getNamePropertyName in interface OwCMISObjectClass

Overrides:

getNamePropertyName in class OwCMISAbstractObjectClass

Throws:

com.wewebu.ow.server.exceptions.OwException

subclassedBy

public void subclassedBy(OwCMISObjectClass subclass_p)
                  throws com.wewebu.ow.server.exceptions.OwInvalidOperationException

Description copied from interface: OwCMISObjectClass

Method called when this class is sub-classed.

Specified by:

subclassedBy in interface OwCMISObjectClass

Overrides:

subclassedBy in class OwCMISAbstractObjectClass

Parameters:

subclass_p - the new child of this class

Throws:

com.wewebu.ow.server.exceptions.OwInvalidOperationException - if the subclass constraints of this class are not met or the this class can not be sub-classed

isAssignableFrom

public boolean isAssignableFrom(OwCMISObjectClass class_p)
                         throws com.wewebu.ow.server.exceptions.OwException

Description copied from interface: OwCMISObjectClass

A java class analogous method : Determines if the object-class represented by this object-class object is either the same as, or is a superclass of the object-class represented by the specified object-class parameter.

Specified by:

isAssignableFrom in interface OwCMISObjectClass

Overrides:

isAssignableFrom in class OwCMISAbstractObjectClass

Returns:

the boolean value indicating whether objects of the type class can be interpreted as objects of this class

Throws:

com.wewebu.ow.server.exceptions.OwException

hasVersionSeries

public boolean hasVersionSeries()
                         throws Exception

Specified by:

hasVersionSeries in interface com.wewebu.ow.server.ecm.OwObjectClass

Overrides:

hasVersionSeries in class OwCMISAbstractObjectClass

Throws:

Exception

getModes

public List<?> getModes(int operation_p)
                 throws Exception

Specified by:

getModes in interface com.wewebu.ow.server.ecm.OwObjectClass

Overrides:

getModes in class OwCMISAbstractObjectClass

Throws:

Exception

canCreateNewObject

public boolean canCreateNewObject()
                           throws com.wewebu.ow.server.exceptions.OwException

Specified by:

canCreateNewObject in interface com.wewebu.ow.server.ecm.OwObjectClass

Specified by:

canCreateNewObject in interface OwCMISObjectClass

Overrides:

canCreateNewObject in class OwCMISAbstractObjectClass

Throws:

com.wewebu.ow.server.exceptions.OwException

getDescription

public String getDescription(Locale locale_p)

Specified by:

getDescription in interface com.wewebu.ow.server.ecm.OwObjectClass

Overrides:

getDescription in class OwCMISAbstractObjectClass

isHidden

public boolean isHidden()
                 throws Exception

Specified by:

isHidden in interface com.wewebu.ow.server.ecm.OwObjectClass

Overrides:

isHidden in class OwCMISAbstractObjectClass

Throws:

Exception

newTransientObject

public <N extends org.apache.chemistry.opencmis.client.api.TransientCmisObject> OwCMISTransientObject<N> newTransientObject(N cmisObject,
                                                                                                                   org.apache.chemistry.opencmis.client.api.OperationContext creationContext)

Specified by:

newTransientObject in interface OwCMISNativeObjectClass<T extends org.apache.chemistry.opencmis.client.api.ObjectType,O extends org.apache.chemistry.opencmis.client.api.TransientCmisObject>

getQueryResultConverter

public OwCMISQueryResultConverter<O> getQueryResultConverter(org.apache.chemistry.opencmis.client.api.QueryResult queryResult,
                                                    com.wewebu.ow.csqlc.ast.OwQueryStatement statement,
                                                    org.apache.chemistry.opencmis.client.api.OperationContext context)
                                                                                                                           throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getQueryResultConverter in interface OwCMISNativeObjectClass<T extends org.apache.chemistry.opencmis.client.api.ObjectType,O extends org.apache.chemistry.opencmis.client.api.TransientCmisObject>

Parameters:

queryResult - the QueryResult to be converted

statement - the CMIS SQL statement that resulted in the give QueryResult

Returns:

an OwCMISQueryResultConverter for query CMIS query results associated with object classes of this type

Throws:

com.wewebu.ow.server.exceptions.OwException

getPreferredPropertyType

public OwCMISPreferredPropertyTypeCfg.PropertyType getPreferredPropertyType(OwCMISPropertyClass<?> propertyClass)
                                                                     throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getPreferredPropertyType in interface OwCMISObjectClass

Throws:

com.wewebu.ow.server.exceptions.OwException

createSkeletonObject

public com.wewebu.ow.server.ecm.OwObjectSkeleton createSkeletonObject(com.wewebu.ow.server.ecm.OwNetwork network_p,
                                                             OwCMISResource res_p,
                                                             OwCMISNativeSession ses_p,
                                                             com.wewebu.ow.server.util.OwXMLUtil initValues_p)
                                                               throws Exception

Description copied from interface: OwCMISObjectClass

Create skeleton Object for this specific object class.

Specified by:

createSkeletonObject in interface OwCMISObjectClass

Overrides:

createSkeletonObject in class OwCMISAbstractObjectClass

Parameters:

network_p - OwNetwork which is currently requesting skeleton object

res_p - OwCMISResource for which skeleton is created

ses_p - OwCMISNativeSession handling the current CMIS binding

initValues_p - OwXMLUtil which should be preset (can be null)

Returns:

OwObjectSkeleton

Throws:

Exception - if could not create skeleton object

createContext

protected org.apache.chemistry.opencmis.client.api.OperationContext createContext(Map<String,?> conversionParameters)

Helper for handling OpenCMIS OperationContext.

Parameters:

conversionParameters - Map conversion parameter (internal transformation)

Returns:

OperationContext

getCopyClassName

public String getCopyClassName()

Description copied from interface: OwCMISObjectClass

Return the class name which is unique and define fully the new type/class of a copy instance.

Specified by:

getCopyClassName in interface OwCMISObjectClass

Overrides:

getCopyClassName in class OwCMISAbstractObjectClass

Returns:

String full type definition, may return the same as OwObjectClass.getClassName()