Java Doc for ContentStorage.java in  » J2EE » fleXive » com » flexive » core » storage » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » fleXive » com.flexive.core.storage 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.flexive.core.storage.ContentStorage

All known Subclasses:   com.flexive.core.storage.genericSQL.GenericHierarchicalStorage,
ContentStorage
public interface ContentStorage (Code)
SQL storage interface for contents
author:
   Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)




Method Summary
 FxPKcontentCreate(Connection con, FxEnvironment env, StringBuilder sql, long newId, FxContent content)
    
 FxPKcontentCreateVersion(Connection con, FxEnvironment env, StringBuilder sql, FxContent content)
    
 FxContentcontentLoad(Connection con, FxPK pk, FxEnvironment env, StringBuilder sql)
    
 voidcontentRemove(Connection con, FxPK pk)
     Remove a content instance and all its versions, will throw an Exception if it is referenced from other contents.
 intcontentRemoveForType(Connection con, FxType type)
     Remove all instances of the given type.
 voidcontentRemoveVersion(Connection con, FxPK pk)
     Remove a content's version, will throw an Exception if it is referenced from other contents.
 FxPKcontentSave(Connection con, FxEnvironment env, StringBuilder sql, FxContent content, long fqnPropertyId)
    
 String[]getColumns(FxProperty prop)
    
 FxContentSecurityInfogetContentSecurityInfo(Connection con, FxPK pk)
    
 FxContentVersionInfogetContentVersionInfo(Connection con, long id)
    
 List<FxPK>getPKsForType(Connection con, FxType type, boolean onePkPerInstance)
    
 intgetReferencedContentCount(Connection con, long id)
    
 StringgetTableName(FxProperty prop)
    
 StringgetUppercaseColumn(FxProperty prop)
     Get the (optional) uppercase column used for this data type.
 voidmaintenance(Connection con)
     Perform maintenance and cleanup tasks.
 voidprepareSave(Connection con, FxContent content)
    
 voidstoreBinary(Connection con, long id, int version, int quality, String name, long length, InputStream binary)
    
 booleanuniqueConditionValid(Connection con, UniqueMode mode, FxProperty prop, long typeId, FxPK pk)
    
 voidupdateBinaryPreview(Connection con, long id, int version, int quality, int preview, int width, int height, long length, InputStream binary)
    
 voidupdateXPath(Connection con, long assignmentId, String originalXPath, String newXPath)
    



Method Detail
contentCreate
FxPK contentCreate(Connection con, FxEnvironment env, StringBuilder sql, long newId, FxContent content) throws FxCreateException, FxInvalidParameterException(Code)
Create a new content instance
Parameters:
  con - an open and valid Connection
Parameters:
  env - Environment
Parameters:
  sql - optional StringBuilder to save performance
Parameters:
  newId - the new Id to assign
Parameters:
  content - the content to persist primary key of the created content
throws:
  FxCreateException - on create errors
throws:
  FxInvalidParameterException - on invalid values/missing required values in content



contentCreateVersion
FxPK contentCreateVersion(Connection con, FxEnvironment env, StringBuilder sql, FxContent content) throws FxCreateException, FxInvalidParameterException(Code)
Create a new version for an existing content instance
Parameters:
  con - an open and valid Connection
Parameters:
  env - Environment
Parameters:
  sql - optional StringBuilder to save performance
Parameters:
  content - the content to persist primary key of the new version
throws:
  FxCreateException - on create errors
throws:
  FxInvalidParameterException - on invalid values/missing required values in content



contentLoad
FxContent contentLoad(Connection con, FxPK pk, FxEnvironment env, StringBuilder sql) throws FxLoadException, FxInvalidParameterException, FxNotFoundException(Code)
Load a content with the given primary key
Parameters:
  con - an open and valid connection
Parameters:
  pk - primary key
Parameters:
  env - Environment
Parameters:
  sql - optional StringBuilder to save performance loaded content
throws:
  FxLoadException - on errors
throws:
  FxInvalidParameterException - on invalid parameters (pk)
throws:
  FxNotFoundException - if no instance for this primary key was found



contentRemove
void contentRemove(Connection con, FxPK pk) throws FxRemoveException(Code)
Remove a content instance and all its versions, will throw an Exception if it is referenced from other contents.
Parameters:
  con - an open and valid connection
Parameters:
  pk - primary key
throws:
  com.flexive.shared.exceptions.FxRemoveException - on errors



contentRemoveForType
int contentRemoveForType(Connection con, FxType type) throws FxRemoveException(Code)
Remove all instances of the given type. Beans using this method should apply very strict security restrictions!
Parameters:
  con - an open and valid connection
Parameters:
  type - affected FxType number of instances removed
throws:
  com.flexive.shared.exceptions.FxRemoveException - on errors



contentRemoveVersion
void contentRemoveVersion(Connection con, FxPK pk) throws FxRemoveException, FxNotFoundException(Code)
Remove a content's version, will throw an Exception if it is referenced from other contents. If the content consists only of this specific version the whole content is removed
Parameters:
  con - an open and valid connection
Parameters:
  pk - primary key for a distinct version
throws:
  com.flexive.shared.exceptions.FxRemoveException - on errors
throws:
  FxNotFoundException - on errors



contentSave
FxPK contentSave(Connection con, FxEnvironment env, StringBuilder sql, FxContent content, long fqnPropertyId) throws FxUpdateException, FxInvalidParameterException(Code)
Save a content instance, creating new versions as needed
Parameters:
  con - an open and valid connection
Parameters:
  env - Environment
Parameters:
  sql - optional StringBuilder to save performance
Parameters:
  content - the content to persist
Parameters:
  fqnPropertyId - id of the FQN property, needed to sync changes back to the tree primary key of the saved content
throws:
  FxUpdateException - on errors
throws:
  FxInvalidParameterException - on errors



getColumns
String[] getColumns(FxProperty prop)(Code)
Get the database columns used for this data type
Parameters:
  prop - requested FxProperty the database columns used



getContentSecurityInfo
FxContentSecurityInfo getContentSecurityInfo(Connection con, FxPK pk) throws FxLoadException, FxNotFoundException(Code)
Get all security relevant information about a content instance identified by its primary key
Parameters:
  con - an open and valid connection
Parameters:
  pk - primary key to query security information for FxContentSecurityInfo
throws:
  FxLoadException - on errors
throws:
  FxNotFoundException - on errors



getContentVersionInfo
FxContentVersionInfo getContentVersionInfo(Connection con, long id) throws FxNotFoundException(Code)
Get information about the versions used for a content id
Parameters:
  con - an open and valid Connection
Parameters:
  id - the id to query version information for FxContentVersionInfo
throws:
  FxNotFoundException - if the requested id does not exist



getPKsForType
List<FxPK> getPKsForType(Connection con, FxType type, boolean onePkPerInstance) throws FxDbException(Code)
Get a list of all primary keys for the given FxType (can be a very long list!!!)
Parameters:
  con - an open and valid connection
Parameters:
  type - the type to request the primary keys for
Parameters:
  onePkPerInstance - return one primary key per instance (with max version) or one per actual version? list containing the primary keys
throws:
  FxDbException - on errors



getReferencedContentCount
int getReferencedContentCount(Connection con, long id) throws FxDbException(Code)
Get the number of references that exist for the requested content id
Parameters:
  con - an open and valid Connection
Parameters:
  id - id of the requested content number of references that exist for the requested content
throws:
  FxDbException - on errors



getTableName
String getTableName(FxProperty prop)(Code)
Get the Database table name for this data type
Parameters:
  prop - FxPropery to request the table name for table name



getUppercaseColumn
String getUppercaseColumn(FxProperty prop)(Code)
Get the (optional) uppercase column used for this data type. If no uppercase column is used, null is returned.
Parameters:
  prop - requested FxPropery uppercase column name or null



maintenance
void maintenance(Connection con)(Code)
Perform maintenance and cleanup tasks. To be called periodically.
Parameters:
  con - an open and valid connection



prepareSave
void prepareSave(Connection con, FxContent content) throws FxInvalidParameterException, FxDbException(Code)
Prepare a content for a save or create operation (resolves binaries for script processing, etc.)
Parameters:
  con - an open and valid Connection
Parameters:
  content - the content to prepare
throws:
  FxInvalidParameterException - on errors
throws:
  FxDbException - on errors



storeBinary
void storeBinary(Connection con, long id, int version, int quality, String name, long length, InputStream binary) throws FxApplicationException(Code)
Create a new or update an existing binary
Parameters:
  con - an open and valid Connection
Parameters:
  id - id of the binary
Parameters:
  version - version of the binary
Parameters:
  quality - quality of the binary
Parameters:
  name - file name
Parameters:
  length - length of the binary
Parameters:
  binary - the binary
throws:
  FxApplicationException - on errors



uniqueConditionValid
boolean uniqueConditionValid(Connection con, UniqueMode mode, FxProperty prop, long typeId, FxPK pk)(Code)
Check if a unique condition is valid for a propery
Parameters:
  con - an open and valid Connection
Parameters:
  mode - UniqueMode
Parameters:
  prop - property
Parameters:
  typeId - type
Parameters:
  pk - primary key (optional) if mode would be valid



updateBinaryPreview
void updateBinaryPreview(Connection con, long id, int version, int quality, int preview, int width, int height, long length, InputStream binary)(Code)
Create a new or update an existing binary
Parameters:
  con - an open and valid Connection
Parameters:
  id - id of the binary
Parameters:
  version - version of the binary
Parameters:
  quality - quality of the binary
Parameters:
  preview - the number of the preview to update (1..3)
Parameters:
  width - width of the preview
Parameters:
  height - height of the preview
Parameters:
  length - length of the binary
Parameters:
  binary - the binary



updateXPath
void updateXPath(Connection con, long assignmentId, String originalXPath, String newXPath) throws FxUpdateException, FxInvalidParameterException(Code)
Update XPath entires of content data
Parameters:
  con - an open and valid connection
Parameters:
  assignmentId - assignment id
Parameters:
  originalXPath - original xpath
Parameters:
  newXPath - new xpath
throws:
  FxInvalidParameterException - if an XPath is not valid
throws:
  FxUpdateException - on errors



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.