|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.service.cmr.repository.TransformationOptions
public class TransformationOptions
Class containing values of options that are passed to content transformers. These options are used to determine the applicability of a content transformer and also during the transformation process to provide context or parameter values.
This base class provides some common, optional contextual information about the source and target nodes and properties used by the transformation.
Field Summary | |
---|---|
static java.lang.String |
OPT_INCLUDE_EMBEDDED
|
static java.lang.String |
OPT_SOURCE_CONTENT_PROPERTY
|
static java.lang.String |
OPT_SOURCE_NODEREF
Option map names to preserve backward compatibility |
static java.lang.String |
OPT_TARGET_CONTENT_PROPERTY
|
static java.lang.String |
OPT_TARGET_NODEREF
|
static org.alfresco.service.cmr.repository.datatype.TypeConverter.Converter |
relaxedBooleanTypeConverter
|
Constructor Summary | |
---|---|
TransformationOptions()
Default construtor |
|
TransformationOptions(java.util.Map optionsMap)
Constructor. |
|
TransformationOptions(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
org.alfresco.service.namespace.QName sourceContentProperty,
org.alfresco.service.cmr.repository.NodeRef targetNodeRef,
org.alfresco.service.namespace.QName targetContentProperty)
Constructor |
Method Summary | |
---|---|
java.lang.Boolean |
getIncludeEmbedded()
If the source content includes embedded resources, should the transformer attempt to transform these as well? Not many transformers do support embedded resources, so this option will only affect those that can. |
org.alfresco.service.namespace.QName |
getSourceContentProperty()
Get the source content property |
org.alfresco.service.cmr.repository.NodeRef |
getSourceNodeRef()
Gets the source node reference |
org.alfresco.service.namespace.QName |
getTargetContentProperty()
Get the target content property |
org.alfresco.service.cmr.repository.NodeRef |
getTargetNodeRef()
Get the target node reference |
void |
setIncludeEmbedded(java.lang.Boolean includeEmbedded)
If the source content includes embedded resources, should the transformer attempt to transform these as well? Not many transformers do support embedded resources, so this option will only affect those that can. |
void |
setSourceContentProperty(org.alfresco.service.namespace.QName sourceContentProperty)
Set the source content property |
void |
setSourceNodeRef(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)
Set the source node reference |
void |
setTargetContentProperty(org.alfresco.service.namespace.QName targetContentProperty)
Set the target content property |
void |
setTargetNodeRef(org.alfresco.service.cmr.repository.NodeRef targetNodeRef)
Set the taget node reference |
java.util.Map |
toMap()
Convert the transformation options into a map. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String OPT_SOURCE_NODEREF
public static final java.lang.String OPT_SOURCE_CONTENT_PROPERTY
public static final java.lang.String OPT_TARGET_NODEREF
public static final java.lang.String OPT_TARGET_CONTENT_PROPERTY
public static final java.lang.String OPT_INCLUDE_EMBEDDED
public static org.alfresco.service.cmr.repository.datatype.TypeConverter.Converter relaxedBooleanTypeConverter
Constructor Detail |
---|
public TransformationOptions()
public TransformationOptions(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.namespace.QName sourceContentProperty, org.alfresco.service.cmr.repository.NodeRef targetNodeRef, org.alfresco.service.namespace.QName targetContentProperty)
sourceNodeRef
- the source node referencesourceContentProperty
- the source content propertytargetNodeRef
- the target node referencetargetContentProperty
- the target content propertypublic TransformationOptions(java.util.Map optionsMap)
optionsMap
- options mapMethod Detail |
---|
public void setSourceNodeRef(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)
sourceNodeRef
- the source node referencepublic org.alfresco.service.cmr.repository.NodeRef getSourceNodeRef()
public void setSourceContentProperty(org.alfresco.service.namespace.QName sourceContentProperty)
sourceContentProperty
- the source content propertypublic org.alfresco.service.namespace.QName getSourceContentProperty()
public void setTargetNodeRef(org.alfresco.service.cmr.repository.NodeRef targetNodeRef)
targetNodeRef
- the target node referencepublic org.alfresco.service.cmr.repository.NodeRef getTargetNodeRef()
public void setTargetContentProperty(org.alfresco.service.namespace.QName targetContentProperty)
targetContentProperty
- the target content propertypublic org.alfresco.service.namespace.QName getTargetContentProperty()
public void setIncludeEmbedded(java.lang.Boolean includeEmbedded)
includeEmbedded
- the include embedded flag.public java.lang.Boolean getIncludeEmbedded()
public java.util.Map toMap()
Basic options (optional) are:
TransformationOptions.OPT_SOURCE_NODEREF
TransformationOptions.OPT_SOURCE_CONTENT_PROPERTY
TransformationOptions.OPT_TARGET_NODEREF
TransformationOptions.OPT_TARGET_CONTENT_PROPERTY
TransformationOptions.OPT_INCLUDE_EMBEDDED
Override this method to append option values to the map. Derived classes should call the base class before appending further values and returning the result.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |