Java Doc for Collection.java in  » Content-Management-System » apache-lenya-2.0 » org » apache » lenya » modules » collection » 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 » Content Management System » apache lenya 2.0 » org.apache.lenya.modules.collection 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.lenya.modules.collection.Collection

All known Subclasses:   org.apache.lenya.modules.collection.CollectionWrapper,
Collection
public interface Collection (Code)
A document representing a collection of documents. This class is in prototyping stage.


Field Summary
 StringATTRIBUTE_HREF
     Name of the href attribute.
 StringATTRIBUTE_TYPE
     Name of the type attribute.
 StringATTRIBUTE_UUID
    
 StringDEFAULT_PREFIX
    
 StringELEMENT_COLLECTION
    
 StringELEMENT_DOCUMENT
    
 StringNAMESPACE
    
 StringTYPE_CHILDREN
     Type for automatic inclusion of child documents.
 StringTYPE_LINK
     Type for manual addition of documents.
 StringTYPE_MANUAL
     Type for manual addition of documents.


Method Summary
 voidadd(Document document)
     Adds a document to the collection.
 voidadd(int position, Document document)
     Inserts a document into the collection at a specific position.
 voidclear()
     Removes all documents from this collection.
 booleancontains(Document document)
     Checks if this collection contains a specific document.
Parameters:
  document - The document to check.
 DocumentgetDelegate()
    
 Document[]getDocuments()
     Returns the documents in this collection.
 intgetFirstPosition(Document document)
     Returns the first position of this document in the collection.
Parameters:
  document - The document.
 StringgetHref()
    
 StringgetType()
    
 voidremove(Document document)
     Removes a document from the collection.
 voidsetHref(String href)
    
Parameters:
  href - The link target.
 voidsetType(String type)
    
 intsize()
     Returns the number of documents in this collection.

Field Detail
ATTRIBUTE_HREF
String ATTRIBUTE_HREF(Code)
Name of the href attribute.



ATTRIBUTE_TYPE
String ATTRIBUTE_TYPE(Code)
Name of the type attribute.



ATTRIBUTE_UUID
String ATTRIBUTE_UUID(Code)
attribute for document IDs



DEFAULT_PREFIX
String DEFAULT_PREFIX(Code)
default namespace prefix



ELEMENT_COLLECTION
String ELEMENT_COLLECTION(Code)
document element



ELEMENT_DOCUMENT
String ELEMENT_DOCUMENT(Code)
element for single document references



NAMESPACE
String NAMESPACE(Code)
collection namespace



TYPE_CHILDREN
String TYPE_CHILDREN(Code)
Type for automatic inclusion of child documents.



TYPE_LINK
String TYPE_LINK(Code)
Type for manual addition of documents.



TYPE_MANUAL
String TYPE_MANUAL(Code)
Type for manual addition of documents.





Method Detail
add
void add(Document document) throws DocumentException(Code)
Adds a document to the collection.
Parameters:
  document - A document.
throws:
  DocumentException - when an error occurs.



add
void add(int position, Document document) throws DocumentException(Code)
Inserts a document into the collection at a specific position.
Parameters:
  document - A document.
Parameters:
  position - The position of the document after insertion,starting with 0.
throws:
  DocumentException - when something went wrong.



clear
void clear() throws DocumentException(Code)
Removes all documents from this collection.
throws:
  DocumentException - when something went wrong.



contains
boolean contains(Document document) throws DocumentException(Code)
Checks if this collection contains a specific document.
Parameters:
  document - The document to check. A boolean value.
throws:
  DocumentException - when something went wrong.



getDelegate
Document getDelegate()(Code)
The document which the collection is stored in.



getDocuments
Document[] getDocuments() throws DocumentException(Code)
Returns the documents in this collection. An array of documents.
throws:
  DocumentException - when something went wrong.



getFirstPosition
int getFirstPosition(Document document) throws DocumentException(Code)
Returns the first position of this document in the collection.
Parameters:
  document - The document. An integer.
throws:
  DocumentException - when the document is not contained.



getHref
String getHref()(Code)
The link target.



getType
String getType()(Code)
One of Collection.TYPE_CHILDREN, Collection.TYPE_MANUAL, Collection.TYPE_LINK.



remove
void remove(Document document) throws DocumentException(Code)
Removes a document from the collection.
Parameters:
  document - A document.
throws:
  DocumentException - when the document is not containedor another error occurs.



setHref
void setHref(String href)(Code)

Parameters:
  href - The link target. If the type is not Collection.TYPE_LINK, callingthis method has no effect.



setType
void setType(String type)(Code)

Parameters:
  type - One of Collection.TYPE_CHILDREN, Collection.TYPE_MANUAL, Collection.TYPE_LINK.



size
int size() throws DocumentException(Code)
Returns the number of documents in this collection. An integer value.
throws:
  DocumentException - when something went wrong.



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