mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
Merged BRANCHES/DEV/V3.3-DAO-REFACTOR-5 to HEAD:
20678: DAO5 branch: Preparation for merge back to HEAD
20689: Merged DAO4 to DAO5
- Removed all 'dbscripts/create/3.x/SomeDialect' and replaced with 'dbscripts/create/SomeDialect'
DB create scripts are taken from latest DAO4
- TODO: FixAuthoritiesCrcValuesPatch needs query implementation in PatchDAO
Merged DAO3 to DAO4
- Reapplied fixes for ALF-713 (race condition on Usages)
19350: Merged BRANCHES/DEV/V3.3-DAO-REFACTOR-2 to BRANCHES/DEV/V3.3-DAO-REFACTOR-3:
18939: SAIL-4 :2nd stage branch for DAO refactor off HEAD rev 18898
18948: Merged V3.3-DAO-REFACTOR to V3.3-DAO-REFACTOR-2
18202: Dev branch for DAO refactor
18252: SAIL-233: QName.hbm.xml
18295: Added missing CREATE TABLE statements for QName-related code
18324: SAIL-234: Node.hbm.xml: Node aspects initial integration
18355: Added 'setValue' method to manually update the cached value
18356: MV property stressing lowered to speed test up
18357: SAIL-234: Node.hbm.xml
18376: Pulled all Alfresco-related create SQL into script
18389: SAIL-234: Permissions DAO refactor - initial checkpoint
18390: Formatting only (line-endings)
18400: SAIL-234: Node.hbm.xml
18418: SAIL-234: Node.hbm.xml: 'alf_node_assoc' CRUD
18429: SAIL-234: Node.hbm.xml: Cleaned out all Hibernate references to NodeAssocImpl
18457: SAIL-234: Permissions DAO refactor
18959: Merged DEV/V3.3-DAO-REFACTOR to DEV/V3.3-DAO-REFACTOR-2
18479: SAIL-234: Node.hbm.xml - fix updateNode (missing id when saving oldDummyNode)
18482: SAIL-235: remove Permissions.hbm.xml
18517: SAIL-235: Permissions DAO refactor
18523: SAIL-234: Node.hbm.xml
18524: SAIL-235: Permissions DAO refactor
18960: Merged DEV/V3.3-DAO-REFACTOR to DEV/V3.3-DAO-REFACTOR-2
18533: Flipped back to Windows line endings
18535: Formatting-only (eol)
18540: Formatting-only (eol)
18541: SAIL-235: Permissions DAO refactor
18543: SAIL-234: Node.hbm.xml: Start alf_store changes
18567: SAIL-235: Permissions DAO refactor
18596: SAIL-305: Alfresco DDL - formatted/rationalized and added missing indexes & fk constraints
18603: SAIL-311: Minor cleanup for schema upgrade scripts (V3.3)
18604: SAIL-311: Remove empty dirs
18619: SAIL-274: Locale.hbm.xml
18621: Added method to create default ACL
18622: SAIL-234: Node.hbm.xml: Store, Transaction, Server and some node
18624: Formatting only (eol)
18631: SAIL-235: Permissions DAO refactor
18633: SAIL-235: Permissions DAO refactor - do not expose CRUD for AceContext (or AuthorityAlias) since currently unused
18639: getLocale(Locale) should return null if it doesn't exist
18640: SAIL-234 NodeDAO: More replacement of node queries and updates
18648: SAIL-310: Create SQL script for core repo tables (All DB ports)
18651: SAIL-234 NodeDAO: Moves across stores handle presence of target deleted nodes
18961: Merged DEV/V3.3-DAO-REFACTOR to DEV/V3.3-DAO-REFACTOR-2
18658: SAIL-274 Locale DAO: Missing getValueKey() method
18662: SAIL-235: Permissions DAO refactor - further cleanup (of DbAccessControlList usage, including copyACLs)
18664: DB scripts porting for PostgreSQL finished.
18668: SAIL-234 Node DAO: Note in case Transaction Change ID is dropped from indexes
18669: SAIL-234 Node DAO: deleteNode and archive (store move) fixes
18672: DB scripts porting for Oracle finished.
18675: SAIL-235: Permissions DAO refactor
18677: DB scripts porting for DB2 finished.
18964: Merged DEV/V3.3-DAO-REFACTOR to DEV/V3.3-DAO-REFACTOR-2
18687: Execute a callback with retries
18688: SAIL-234 Node DAO: Child association creation
18690: SAIL-234 Node DAO: Comment out raw creation of stores as it breaks subsequent bootstrap checks
18691: SAIL-234 Node DAO: More replacement of alf_child_assoc handling
18713: Commented about needing a more efficient removeChildAssociation method
18714: SAIL-234 Node DAO: Replaced queries on alf_child_assoc
18715: SAIL-234 Node DAO: More alf_child_assoc query replacement
18727: SAIL-234 Node DAO: alf_child_assoc queries complete
18737: SAIL-234 Node DAO: Tweaks to newNode and implemented prependPaths
18741: SAIL-234 and SAIL-334: Moved UsageDelta Hibernate code and queries over to UsageDeltaDAO
18748: SAIL-234 Node DAO: fix NPE (EditionServiceImplTest)
18769: SAIL-234 Node DAO: alf_node_properties ground work
18786: SAIL-234 Node DAO: alf_node_properties and cm:auditable properties
18810: Added EqualsHelper.getMapComparison
18813: TransactionalCache propagates cache clears and removals during rollback
18826: SAIL-234 Node DAO: Moved over sundry references to NodeDaoService to NodeDAO
18849: SAIL-237: UsageDelta.hbm.xml - eol formatting only (including removal of unwanted svn:eol-style=native property)
18869: SAIL-234 NodeDAO: Fixed more references to 'nodeDaoService'
18895: SAIL-234 NodeDAO: Queries for alf_transaction
18899: SAIL-234 Node DAO: Fixed bean fetching for 'nodeDAO'
18909: SAIL-234 NodeDAO: Fixes to getNodeRefStatus and various txn queries
18916: SAIL-234 NodeDAO: Fixed moveNode alf_child_assoc updates
18922: SAIL-235: DAO refactoring: Permission.hbm.xml
18930: SAIL-235: DAO refactoring: Permission.hbm.xml
18932: SAIL-234 NodeDAO: Fixing up gotchas, javadocs and some naming
18933: SAIL-234 NodeDAO: Minor neatening
18935: SAIL-234 Node DAO: Caches for ID to NodeRef and StoreRef
18936: EHCache config files line endings
18938: SAIL-237: Usage DAO refactor - initial checkpoint
18945: SAIL-235: DAO refactoring: Permission.hbm.xml. Move Node.
18975: Fix for move-node ACL jiggery-pokery
19067: SAIL-4: fix VersionHistoryImpl.getSuccessors (causing VersionServiceImplTest.testGetVersionHistorySameWorkspace failure)
19068: SAIL-234: fix VersionMigratorTest.testMigrateOneVersion
19074: SAIL-237: Usage DAO - update to common iBatis mapping pattern(s) to ease DB porting
19076: SAIL-231: Activities DAO - update to common iBatis mapping pattern(s)
19077: SAIL-232: AppliedPatch DAO - minor cleanup (comments & formatting only)
19092: Merging HEAD to DEV/V3.3-DAO-REFACTOR-2
18973: Temporarily comment out AVMTestSuite and run AVM tests individually
19056: AVM unit test improvements
19097: SAIL-235: DAO refactoring: Permission.hbm.xml: Additional index to support queries to find the id and acl id for the primary children of a node.
19185: SAIL-238: Permissions DAO - (minor) update to common iBatis mapping pattern
19289: SAIL-234 NodeDAO: Node cache replaces NodeRef cache
19302: SAIL-234 Node DAO: Added cache for node properties
19318: SAIL-4: AVM DAO - (minor) update to common iBatis mapping pattern
20690: Merged BRANCHES/DEV/V3.3-DAO-REFACTOR-4 to BRANCHES/DEV/V3.3-DAO-REFACTOR-5:
20063: (RECORD ONLY) DAO refactor branch V4
20146: Merged BRANCHES/DEV/V3.3-DAO-REFACTOR-3 to BRANCHES/DEV/V3.3-DAO-REFACTOR-4:
19401: SAIL-234 Node DAO: Fix permission service tests (setPrimaryChildrenSharedAclId needs to invalidate nodesCache)
19428: Fixed TransactionalCache issue with null and NullValueMarker
19429: Took empty cm:content creation out of FileFolderService#createImpl
19430: SAIL-234 Node DAO: Tweaks around caching and cm:auditable
19431: SAIL-4 DAO Refactor: Exception thrown when attempting writes in read-only txn have changed
19436: SAIL-234 Node DAO: Fix NPE during cm:auditable update
19475: Allow debugging of code without stepping into trivial stuff
19476: Follow-up on 19429 by ensuring CIFS/FTP set a mimetype on the ContentWriter
19477: SAIL-234 Node DAO: Leverage DAO better for NodeService.addProperties
19478: SAIL-234 NodeDAO: Added toString() for ParentAssocsInfo (cache value for parent assocs)
19479: SAIL-234 Node DAO: Fixed for parent association and property caches
19480: Made TransactionAwareSingleton bind-key a GUID
19481: SAIL-234 Node DAO: Reinstated 100K collection property tests
19482: SAIL-234 Node DAO: Node and property cache fixes highlighted by unit tests
19483: SAIL-234 Node DAO: Start on NodeBulkLoader implementation
19595: SAIL-234 Node DAO: Fix moveNode to detect cyclic relationship prior to updating ACLs for moved tree FileFolderServiceImplTest.testETHREEOH_3088_MoveIntoSelf)
20147: Merged BRANCHES/DEV/V3.3-DAO-REFACTOR-3 to BRANCHES/DEV/V3.3-DAO-REFACTOR-4:
19602: (RECORD ONLY) Reintegrated with HEAD up to rev 19433
19621: (RECORD ONLY) SAIL-347
19683: (RECORD ONLY) Reverse-merged 19621 for SAIL-347
19722: (RECORD ONLY) Merged /alfresco/HEAD:r19434-19721
20150: Merged BRANCHES/DEV/V3.3-DAO-REFACTOR-3 to BRANCHES/DEV/V3.3-DAO-REFACTOR-4:
19741: Merged DEV\V3.3-DAO-REFACTOR-2 to DEV\V3.3-DAO-REFACTOR-3
19739: Extended "move" tests
19743: Fix AuditableAspectTest.testAddAspect (to allow for node modified date tolerance)
19748: Remaining part of merge from HEAD to V3.3-DAO-REFACTOR-3
19367: Merged BRANCHES/V3.2 to HEAD:
19286: Fix for ALF-626 "Using 'null' as an authority argument in clearPermissions() cause a java.lang.NullPointerException"
19755: SAIL-234 Node DAO: Fix RepoAdminServiceImplTest.testConcurrentDynamicModelDelete (handle InvalidNodeRefException after getChildAssocs)
20692: Merged BRANCHES/DEV/V3.3-DAO-REFACTOR-4 to BRANCHES/DEV/V3.3-DAO-REFACTOR-5:
- Retired all 1.3 and 1.4 upgrade scripts ... R.I.P.
- Fixed CRC patch for Authorities (only tested on MySQL)
- Fixed SQL patch revision numbers and bumped version schema number up
20158: Merged BRANCHES/DEV/V3.3-DAO-REFACTOR-3 to BRANCHES/DEV/V3.3-DAO-REFACTOR-4:
19773: SQL mappings and scripts: SAIL-310, SAIL-304, SAIL-303 and SAIL-347
19774: Futher fix for SAIL-310: Sequence patch must take into account sequences created for 3.3
19851: SAIL-371 (SAIL-294) NodeDAO fallout: Fix QName and Namespace read/write handling and bean name in unit test
20183: Merged DAO3 to DAO4
19852: SAIL-370: Remove LinkValidation
19853: SAIL-239 (SAIL-294) Attributes.hbm.xml: Added ability to attach arbitrary property to unique context
19857: SAIL-373 Fallout from Permissions DAO refactor (SAIL-235)
19864: SAIL-239 (SAIL-294): Removed AttributeService RMI API
19865: More SAIL-239 (SAIL-294): Removed AttributeService RMI API
20208: DAO-refactor implementation of ALF-2712 query improvements
20209: Merged BRANCHES/DEV/V3.3-DAO-REFACTOR-3 to BRANCHES/DEV/V3.3-DAO-REFACTOR-4:
20060: Removal of AttributeService for SAIL-239 (SAIL-294)
20348: SAIL-371 (SAIL-294): Protect collection properties during map insert and retrieval
20547: SAIL-371 (SAIL-294) Attributes.hbm.xml: implement getAttributes + fixes
20573: SAIL-371 (SAIL-294): NodeDAO: Fix unit tests and other fallout
20597: SAIL-239 Attributes.hbm.xml: WCM/AVM locking test fixes (wip)
20598: SAIL-239 Attributes.hbm.xml: WCM/AVM locking test fixes (wip) - fix AssetServiceImplTest.testSimpleLockFile NPE
20600: Fix PropertyValueDAOTest.testPropertyValue_Enum (follow-on to r20060 for SAIL-239 - which introduces ENUM prop vals)
20601: Fix UsageDAOTest.testCreateAndDeleteUsageDeltas NPE (would also affect ContentStoreCleanerScalabilityRunner)
20603: Fix CMISPropertyServiceTest.* (fallout from r20146 <- r19429 <- Took empty cm:content creation out of FileFolderService#createImpl)
20604: SAIL-371 (SAIL-294): NodeDAO: Fix unit tests - TransferServiceImplTest.*
20618: SAIL-371 (SAIL-294): NodeDAO: AuditableAspectTest (fix testCreateNodeWithAuditableProperties_ALF_2565 + add remove aspect test)
20624: SAIL-371 (SAIL-294): NodeDAO: Fix unit tests - UserUsageTest.*
20626: Fixed random keys for RuleTrigger NodeRef tracking
20635: SAIL-371 (SAIL-294): NodeDAO: Fix unit tests - PersonTest.testSplitDuplicates
20642: SAIL-371 (SAIL-294) DAO: Fixed CacheTest
20643: Removed must of the 'distribute' target's dependencies. Not for HEAD
20645: Follow-on to r20643 (Removed most of the 'distribute' target's dependencies. Not for HEAD)
20654: SAIL-371 (SAIL-294): NodeDAO: DMDeploymentTargetTest.* (do not try to remove mandatory aspects)
20655: SAIL-371 (SAIL-294): NodeDAO: Initial fix for TaggingServiceImplTest.testTagScopeUpdateViaNodePolicies (+ minor test cleanup)
20657: SAIL-371 (SAIL-294): NodeDAO: Fix unit tests - VersionMigratorTest.testMigrateOneVersion (cm:accessed not returned if null)
20658: Merged (back merge only - no merge info) BRANCHES/V3.3 to BRANCHES/DEV/V3.3-DAO-REFACTOR-4:
20090: Dynamic models: minor improvements to DictionaryModelType
20554: Improvement to model delete validation (investigating intermittent failure of RepoAdminServiceImplTest.testSimpleDynamicModelViaNodeService)
20662: SAIL-371 (SAIL-294): NodeDAO: Fix unit tests - RecordsManagementAuditServiceImplTest.* (we now ignore attempt to update 'cm:modifier' prop so update 'cm:title' prop instead)
20666: SAIL-371 (SAIL-294): NodeDAO: Fix unit tests - ADMLuceneTest.*
20668: SAIL-239 (SAIL-294) - delete WCM locks + tests (follow-on to r20060)
20674: SAIL-371 (SAIL-294) NodeDAO fallout: Cleaner and additional checks for ContentStoreCleaner
20675: SAIL-371 (SAIL-294) NodeDAO fallout: Fixed handling of ContentData
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@20693 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
@@ -1,4 +1,4 @@
|
||||
/*
|
||||
/*
|
||||
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
||||
*
|
||||
* This file is part of Alfresco
|
||||
@@ -14,321 +14,122 @@
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package org.alfresco.service.cmr.attributes;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.alfresco.repo.attributes.Attribute;
|
||||
import org.alfresco.service.PublicService;
|
||||
import org.alfresco.util.Pair;
|
||||
import org.alfresco.service.Auditable;
|
||||
import org.alfresco.service.NotAuditable;
|
||||
|
||||
/**
|
||||
* This provides services for reading, writing, and querying global attributes.
|
||||
* <p>
|
||||
* Attributes are organized hierarchically.
|
||||
* Each segment within the hierarchy is referred to as a "key".
|
||||
* Keys are indexed so that they may be queried efficiently.
|
||||
* Because databases may impose length restrictions
|
||||
* on index of primary keys, you are strongly advised to keep
|
||||
* "large" strings in <em>values</em>, not <em>keys</em>.
|
||||
* For example,
|
||||
* http://dev.mysql.com/tech-resources/crash-me.php reports
|
||||
* that the index length limit of MySQL-4.1.1pre InnoDB is 1024,
|
||||
* bytes. Assuming keys are stored in UTF8, this means keys
|
||||
* should be no longer 170 chars (170*6 + 1 = 1020 < 1024).
|
||||
* <p>
|
||||
*
|
||||
* When an attribute within the hierarchy is represented as a "path",
|
||||
* the set of keys used to reach it is concatenated using the '/' character.
|
||||
* Thus, "a/b/c" refers to attribute "c" within "b" within "a".
|
||||
* This "path" notation is merely a convenience; if you prefer,
|
||||
* lower-level functions can also be used that allow you to
|
||||
* supply the list of keys directly. If you need to create a "path"
|
||||
* that includes a key with an embedded '/' character, you must
|
||||
* escape it with '\' (e.g.: "silly\/example"). No such restriction
|
||||
* applies when you use an API that accepts a list of keys directly.
|
||||
* <p>
|
||||
* Lookups for attributes never attempt to search any other
|
||||
* leaf key (final path segment) than the one specified
|
||||
* function call. Thus, if you have an attribute named
|
||||
* "egg", but no attribute named "hen/egg", a lookup for
|
||||
* "egg" will suceed, but a lookup for "hen/egg" will fail
|
||||
* (i.e.: it will return null).
|
||||
*
|
||||
* @author britt
|
||||
*/
|
||||
@PublicService
|
||||
public interface AttributeService
|
||||
{
|
||||
/**
|
||||
* Get an Attribute using a path.
|
||||
*
|
||||
* @param path The path of the Attribute
|
||||
* @return The value of the attribute or null.
|
||||
*/
|
||||
@NotAuditable
|
||||
public Attribute getAttribute(String path);
|
||||
|
||||
/**
|
||||
* Get an attribute using a list of keys.
|
||||
*
|
||||
* @param keys List of attribute path keys (path components).
|
||||
* @return The value of the attribute or null.
|
||||
*/
|
||||
@NotAuditable
|
||||
public Attribute getAttribute(List<String> keys);
|
||||
|
||||
/**
|
||||
* Set an attribute, overwriting its prior value if it already existed.
|
||||
*
|
||||
* @param name The name of the Attribute.
|
||||
* @param value The value to set.
|
||||
*/
|
||||
@NotAuditable
|
||||
public void setAttribute(String path, String name, Attribute value);
|
||||
|
||||
/**
|
||||
* Set an attribute, overwriting its prior value if it already existed.
|
||||
*
|
||||
* @param keys List of attribute path keys (path components).
|
||||
* @param name The name of the attribute to set.
|
||||
* @param value The Attribute to set.
|
||||
*/
|
||||
@NotAuditable
|
||||
public void setAttribute(List<String> keys, String name, Attribute value);
|
||||
|
||||
/**
|
||||
* Set a set of attributes on a map.
|
||||
* @param path The path to the map.
|
||||
* @param entries The entries to set.
|
||||
*/
|
||||
@NotAuditable
|
||||
public void setAttributes(String path, Map<String, Attribute> entries);
|
||||
|
||||
/**
|
||||
* Set a set of attributes on a map.
|
||||
* @param keys The List of path keys to the map.
|
||||
* @param entries The entries to set.
|
||||
*/
|
||||
@NotAuditable
|
||||
public void setAttributes(List<String> keys, Map<String, Attribute> entries);
|
||||
|
||||
/**
|
||||
* Set an attribute in a list.
|
||||
*
|
||||
* @param path The path to the {@link org.alfresco.repo.attributes.ListAttribute ListAttribute}.
|
||||
* @param index The list index.
|
||||
* @param value The Attribute to set.
|
||||
*/
|
||||
@NotAuditable
|
||||
public void setAttribute(String path, int index, Attribute value);
|
||||
|
||||
/**
|
||||
* Set an attribute in a list.
|
||||
* @param keys List of attribute path keys (path components).
|
||||
* @param index The list index.
|
||||
* @param value The Attribute to set within the {@link org.alfresco.repo.attributes.ListAttribute ListAttribute}
|
||||
*/
|
||||
@NotAuditable
|
||||
public void setAttribute(List<String> keys, int index, Attribute value);
|
||||
|
||||
/**
|
||||
* Add an attribute to a list.
|
||||
*
|
||||
* @param path The path to the list.
|
||||
* @param value The Attribute to add to the {@link org.alfresco.repo.attributes.ListAttribute ListAttribute}
|
||||
*/
|
||||
@NotAuditable
|
||||
public void addAttribute(String path, Attribute value);
|
||||
|
||||
/**
|
||||
* Add an attribute to a list.
|
||||
*
|
||||
* @param keys List of attribute path keys (path components).
|
||||
* @param value The Attribute to add to the {@link org.alfresco.repo.attributes.ListAttribute ListAttribute}
|
||||
*/
|
||||
@NotAuditable
|
||||
public void addAttribute(List<String> keys, Attribute value);
|
||||
|
||||
/**
|
||||
* Add a list of attributes to the end of a list.
|
||||
* @param path The path to the list.
|
||||
* @param values The values to add.
|
||||
*/
|
||||
@NotAuditable
|
||||
public void addAttributes(String path, List<Attribute> values);
|
||||
|
||||
/**
|
||||
* Add a list of attributes to the end of a list.
|
||||
* @param keys The List of path keys to the list.
|
||||
* @param values The values to add.
|
||||
*/
|
||||
@NotAuditable
|
||||
public void addAttributes(List<String> keys, List<Attribute> values);
|
||||
|
||||
/**
|
||||
* Remove an Attribute.
|
||||
* @param name The name of the Attribute.
|
||||
*/
|
||||
@NotAuditable
|
||||
public void removeAttribute(String path, String name);
|
||||
|
||||
/**
|
||||
* Remove an Attribute.
|
||||
* @param keys List of attribute path keys (path components).
|
||||
* @param name The name of the attribute to remove.
|
||||
*/
|
||||
@NotAuditable
|
||||
public void removeAttribute(List<String> keys, String name);
|
||||
|
||||
/**
|
||||
* Remove an attribute from a list.
|
||||
* @param path The path to the list.
|
||||
* @param index The index to remove from the
|
||||
* {@link org.alfresco.repo.attributes.ListAttribute ListAttribute}
|
||||
*/
|
||||
@NotAuditable
|
||||
public void removeAttribute(String path, int index);
|
||||
|
||||
/**
|
||||
* Remove an attribute from a list.
|
||||
* @param keys List of attribute path keys (path components).
|
||||
* @param index The index to remove from the
|
||||
* {@link org.alfresco.repo.attributes.ListAttribute ListAttribute}
|
||||
*/
|
||||
@NotAuditable
|
||||
public void removeAttribute(List<String> keys, int index);
|
||||
|
||||
/**
|
||||
* Remove entries from the designated map which match the given query.
|
||||
* @param keys The list of attribute path entries.
|
||||
* @param query The attribute query.
|
||||
*/
|
||||
@NotAuditable
|
||||
public void removeEntries(List<String> keys, AttrQuery query);
|
||||
|
||||
/**
|
||||
* Remove entries from the designated map which match the given query.
|
||||
* @param path The path to the map.
|
||||
* @param query The attribute query.
|
||||
*/
|
||||
@NotAuditable
|
||||
public void removeEntries(String path, AttrQuery query);
|
||||
|
||||
/**
|
||||
* Query for the list of attributes that is contained in the map
|
||||
* defined by the given path and meet the query criteria.
|
||||
*
|
||||
* <p>
|
||||
* <b>Example 1:</b><br>
|
||||
* Find all attributes within the nested namespace "a/b"
|
||||
* that are lexically greater than or equal to the string "v":
|
||||
* <pre>
|
||||
* query("a/b", new AttrQueryGTE("v"))
|
||||
* </pre>
|
||||
* <p>
|
||||
* <b>Example 2:</b><br>
|
||||
* Find all attributes within the namespace "xyz" that are
|
||||
* either lexically less than the string "d" or greater than
|
||||
* the string "w":
|
||||
* <pre>
|
||||
* query("xyz", new AttrOrQuery(new AttrQueryLT("d"),
|
||||
* new AttrQueryGT("w")))
|
||||
* </pre>
|
||||
*
|
||||
* @param path
|
||||
* @param query
|
||||
* @return A List of matching attributes.
|
||||
*/
|
||||
@NotAuditable
|
||||
public List<Pair<String, Attribute>> query(String path, AttrQuery query);
|
||||
|
||||
/**
|
||||
* Query for a list of attributes which are contained in a map defined by the
|
||||
* given path and meet the query criteria.
|
||||
* @param keys List of attribute path keys (path components).
|
||||
* @param query
|
||||
* @return A list of matching attributes.
|
||||
*/
|
||||
@NotAuditable
|
||||
public List<Pair<String, Attribute>> query(List<String> keys, AttrQuery query);
|
||||
|
||||
/**
|
||||
* Get all the keys at a given attribute path.
|
||||
* When prior call to
|
||||
* {@link #setAttribute setAttribute}
|
||||
* has associated a path with a
|
||||
* {@link org.alfresco.repo.attributes.Attribute.Type#MAP MAP}, you can fetch the
|
||||
* keys for that map via this function.
|
||||
* <p>
|
||||
* <b>Example:</b><br>
|
||||
* Suppose <code>AttribSvc</code> is an attribute service object:<pre>
|
||||
*
|
||||
* MapAttribute x = new MapAttributeValue();
|
||||
* x.put("cow", new StringAttributeValue("moo");
|
||||
* x.put("bird", new StringAttributeValue("tweet");
|
||||
*
|
||||
* MapAttribute y = new MapAttributeValue();
|
||||
* y.put("pekingese", new StringAttributeValue("yip-yip-yip");
|
||||
* y.put("blood hound", new StringAttributeValue("Aroooooooooooo");
|
||||
* y.put("labrador", new StringAttributeValue("Hello, kind stranger!");
|
||||
*
|
||||
* AttribSvc.setAttribute("", "x", x);
|
||||
* AttribSvc.setAttribute("x", "y", y);
|
||||
*
|
||||
* List<String> x_keys = AttribSvc.getKeys("x"); // cow, bird
|
||||
* List<String> y_keys = AttribSvc.getKeys("x/y"); // pekingese, blood hound, labrador
|
||||
* </pre>
|
||||
*
|
||||
* @param path The attribute path.
|
||||
* @return A list of all keys.
|
||||
*/
|
||||
@NotAuditable
|
||||
public List<String> getKeys(String path);
|
||||
|
||||
/**
|
||||
* Get all the keys at a given attribute path as specified by a list of path components.
|
||||
* @param keys List of attribute path keys (path components).
|
||||
* @return A list of all keys at the specified Attribute location
|
||||
*/
|
||||
@NotAuditable
|
||||
public List<String> getKeys(List<String> keys);
|
||||
|
||||
/**
|
||||
* Get the size of a map or list.
|
||||
* @param keys List of attribute path keys.
|
||||
* @return The size of of the list or map.
|
||||
*/
|
||||
@NotAuditable
|
||||
public int getCount(List<String> keys);
|
||||
|
||||
/**
|
||||
* Get the size of a map or list.
|
||||
* @param path The path to the map or list.
|
||||
* @return The size of the list or map.
|
||||
*/
|
||||
@NotAuditable
|
||||
public int getCount(String path);
|
||||
|
||||
/**
|
||||
* Does an attribute exist.
|
||||
* @param keys List of attribute path keys.
|
||||
* @return Whether the attribute exists.
|
||||
*/
|
||||
@NotAuditable
|
||||
public boolean exists(List<String> keys);
|
||||
|
||||
/**
|
||||
* Does an attribute exist.
|
||||
* @param path The path to the attribute.
|
||||
* @return Whether the attribute exists.
|
||||
*/
|
||||
@NotAuditable
|
||||
public boolean exists(String path);
|
||||
}
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package org.alfresco.service.cmr.attributes;
|
||||
|
||||
import java.io.Serializable;
|
||||
|
||||
import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter;
|
||||
|
||||
/**
|
||||
* This provides services for reading, writing, and querying global attributes.
|
||||
* <p/>
|
||||
* Attributes are uniquely identified by up to 3 keys; <tt>null</tt> keys are themselves treated uniquely i.e.
|
||||
* <code>['a','b']</code> is equivalent to <code>['a','b',null]</code> in all cases except where multiple search results
|
||||
* are possible. Keys can be any simple <code>Serializable</code> type, typically being convertable using
|
||||
* {@link DefaultTypeConverter}. The attribute values persisted can be any <code>Serializable</code>
|
||||
* (including collections) but the raw values should be convertable by the {@link DefaultTypeConverter} for
|
||||
* the most efficient persistence.
|
||||
*
|
||||
* @author Derek Hulley
|
||||
* @since 3.4
|
||||
*/
|
||||
public interface AttributeService
|
||||
{
|
||||
/**
|
||||
* Determine if a particular attribute exists.
|
||||
*
|
||||
* @param keys List of 1 to 3 keys to uniquely identify the attribute
|
||||
* @return <tt>true</tt> if the attribute exists (regardless of its value)
|
||||
* or <tt>false</tt> if it doesn't exist
|
||||
*/
|
||||
public boolean exists(Serializable ... keys);
|
||||
|
||||
/**
|
||||
* Get an attribute using a list of unique keys
|
||||
*
|
||||
* @param keys List of 1 to 3 keys to uniquely identify the attribute
|
||||
* @return The attribute value or <tt>null</tt>
|
||||
*/
|
||||
public Serializable getAttribute(Serializable ... keys);
|
||||
|
||||
/**
|
||||
* Callback used for querying for lists of attributes.
|
||||
*
|
||||
* @author Derek Hulley
|
||||
* @since 3.4
|
||||
*/
|
||||
public interface AttributeQueryCallback
|
||||
{
|
||||
/**
|
||||
* Handle an attribute value
|
||||
*
|
||||
* @param id the unique attribute ID
|
||||
* @param value the value associated with the attribute
|
||||
* @param keys the unique attribute keys
|
||||
* @return <tt>true</tt> to continue sending results if any are available
|
||||
*/
|
||||
boolean handleAttribute(Long id, Serializable value, Serializable[] keys);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all attributes that share the starter keys provided. If 3 key values are given,
|
||||
* there can be, at most, one result.
|
||||
*
|
||||
* @param callback the callback that handles the results
|
||||
* @param keys 0 to 3 key values to search against
|
||||
*/
|
||||
public void getAttributes(AttributeQueryCallback callback, Serializable ... keys);
|
||||
|
||||
/**
|
||||
* Set an attribute, overwriting its prior value if it already existed. <tt>null</tt>
|
||||
* values are treated as unique i.e. if the value set is <tt>null</tt> then
|
||||
* {@link #exists(String...)} will still return <tt>true</tt>. If the attribute doesn't
|
||||
* exist, it will be created otherwise it will be modified.
|
||||
*
|
||||
* @param value The value to store (can be a collection or <tt>null</tt>)
|
||||
* @param keys List of 1 to 3 keys to uniquely identify the attribute
|
||||
*/
|
||||
public void setAttribute(Serializable value, Serializable ... keys);
|
||||
|
||||
/**
|
||||
* Create an attribute with an optional value, assuming there is no existing attribute
|
||||
* using the same keys.
|
||||
*
|
||||
* @param value The value to store (can be a collection or <tt>null</tt>)
|
||||
* @param keys List of 1 to 3 keys to uniquely identify the attribute
|
||||
*
|
||||
* @throws DuplicateAttributeException if the attribute already exists
|
||||
*/
|
||||
public void createAttribute(Serializable value, Serializable ... keys);
|
||||
|
||||
/**
|
||||
* Update an attribute key whilst preserving the associated value (if any). If there is
|
||||
* no existing key matching the original value, then nothing will happen.
|
||||
*
|
||||
* @param keyBefore1 the first part of the original unique key (never <tt>null</tt>)
|
||||
* @param keyBefore2 the second part of the original unique key (<tt>null</tt> allowed)
|
||||
* @param keyBefore3 the third part of the original unique key (<tt>null</tt> allowed)
|
||||
* @param keyAfter1 the first part of the new unique key (never <tt>null</tt>)
|
||||
* @param keyAfter2 the second part of the new unique key (<tt>null</tt> allowed)
|
||||
* @param keyAfter3 the third part of the new unique key (<tt>null</tt> allowed)
|
||||
*/
|
||||
public void updateOrCreateAttribute(
|
||||
Serializable keyBefore1, Serializable keyBefore2, Serializable keyBefore3,
|
||||
Serializable keyAfter1, Serializable keyAfter2, Serializable keyAfter3);
|
||||
|
||||
/**
|
||||
* Remove a specific attribute.
|
||||
*
|
||||
* @param keys up to 3 keys to uniquely identify the attribute
|
||||
*/
|
||||
public void removeAttribute(Serializable ... keys);
|
||||
|
||||
/**
|
||||
* Remove all attributes that share a set of keys (in order)
|
||||
*
|
||||
* @param keys up to 3 keys to identify attributes to remove
|
||||
*/
|
||||
public void removeAttributes(Serializable ... keys);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user