PropertiesFileMetadataLoader (Alfresco Repository)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.alfresco.repo.bulkimport.metadataloaders
Class PropertiesFileMetadataLoader

java.lang.Object
  org.alfresco.repo.bulkimport.metadataloaders.PropertiesFileMetadataLoader

All Implemented Interfaces:: MetadataLoader

public final class PropertiesFileMetadataLoader
extends java.lang.Object
extends java.lang.Object

MetadataLoader that loads metadata from an (optional) "shadow" properties file. This shadow properties file must have exactly the same name and extension as the file for whom it is storing metadata, but with the suffix ".metadata.properties". So for example, if there is a file called "IMG_1967.jpg", the "shadow" properties metadata file for it would be called "IMG_1967.jpg.metadata.properties". The metadata file itself follows the usual rules for Java properties files, with a property with the key "type" containing the qualified name of the content type to use for the file, a property with the key "aspects" containing a comma-delimited list of qualified names of the aspects to attach to the file, and then one Java property per metadata property, with the key being the Alfresco property QName and the value being the value of that property. For example (note escaping rules for namespace separator!): type=cm:content aspects=cm:versionable, custom:myAspect cm\:title=This is the value of the cm:title field. cm\:description=This is the value of the cm:description field. cm\:taggable=workspace://SpacesStore/3da6c395-3a4b-4a57-836d-8e5 custom\:myProperty=This is the value of the custom:myProperty field. custom\:aDateProperty=2001-01-01T12:00:00.000+01:00 Notes:

Java properties files do not support Unicode characters - all values are loaded assuming an ISO-8859-1 character set. For Unicode metadata, you should use XmlPropertiesFileMetadataLoader instead.
the metadata must conform to the type and aspect definitions configured in Alfresco (including mandatory fields, constraints and data types). Any violations will terminate the bulk import process.
associations are not yet supported
dates, times and date times must be stored in ISO8601 format (although note that Alfresco ignores timezone modifiers)

Since:: 4.0
See Also:: MetadataLoader

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.bulkimport.MetadataLoader
`MetadataLoader.Metadata`

Field Summary
`protected org.alfresco.service.cmr.dictionary.DictionaryService`	`dictionaryService`
`protected java.lang.String`	`metadataFileExtension`
`protected java.lang.String`	`multiValuedSeparator`
`protected org.alfresco.service.namespace.NamespaceService`	`namespaceService`

Fields inherited from interface org.alfresco.repo.bulkimport.MetadataLoader
`METADATA_SUFFIX`

Constructor Summary
`PropertiesFileMetadataLoader(ServiceRegistry serviceRegistry)`
`PropertiesFileMetadataLoader(ServiceRegistry serviceRegistry, java.lang.String multiValuedSeparator)`

Method Summary
`java.lang.String`	`getMetadataFileExtension()`
`void`	`loadMetadata(ImportableItem.ContentAndMetadata contentAndMetadata, MetadataLoader.Metadata metadata)` Method that populates the type, aspects and properties to attach to a given file or space.
`protected java.util.Map`	`loadMetadataFromFile(java.io.File metadataFile)` Method that actually loads the properties from the file.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

namespaceService

protected final org.alfresco.service.namespace.NamespaceService namespaceService

dictionaryService

protected final org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService

multiValuedSeparator

protected final java.lang.String multiValuedSeparator

metadataFileExtension

protected final java.lang.String metadataFileExtension

Constructor Detail