Java Doc for Domain.java in  » Content-Management-System » harmonise » org » openharmonise » rm » resources » metadata » properties » domains » 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 » harmonise » org.openharmonise.rm.resources.metadata.properties.domains 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.openharmonise.rm.resources.metadata.properties.domains.Domain

All known Subclasses:   org.openharmonise.rm.resources.workflow.properties.domains.WorkflowPropertyDomain,
Domain
public class Domain implements Publishable,Cloneable(Code)
This class represents a property domain which can be associated to a Property can apply to within Harmonise. A property domain defines the set of objects that may have an instance of the associated property. The domain may be restricted by object type, path and content type.
author:
   Michael Bell
version:
   $Revision: 1.3 $


Field Summary
final public static  StringATTRIB_DEPTH
    
final public static  StringATTRIB_MAX_OCCURS
    
final public static  StringATTRIB_MIN_OCCURS
    
final public static  StringCLMN_CONTENT_TYPE
    
final public static  StringCLMN_DEPTH
    
final public static  StringCLMN_DETAILS_DOMAIN_ID
    
final public static  StringCLMN_DOMAIN_DETAILS
     Domain details database column name.
final public static  StringCLMN_DOMAIN_ID
    
final public static  StringCLMN_DOMAIN_OBJECT
    
final public static  StringCLMN_MAX_OCCURS
    
final public static  StringCLMN_MIN_OCCURS
    
final public static  StringCLMN_PROPERTY_KEY
    
final public static  StringSEQ_DOMAIN
    
final public static  StringTAG_CONTENT_RESTRICTIONS
    
final public static  StringTAG_DOMAIN
    
final public static  StringTAG_DOMAIN_DETAILS
    
final public static  StringTAG_DOMAIN_OBJECT
    
final public static  StringTAG_PATH
    
public  StringTAG_PATHRESTRICTION
    
final public static  StringTBL_DOMAIN_CONTENT_RESTRICTIONS
    
final public static  StringTBL_DOMAIN_DETAILS
    
final public static  StringTBL_NAME
    
final public static  intUNBOUNDED
    
public static  Mapm_child_parent_mappings
     Map of child class to parent classes.

Constructor Summary
public  Domain()
     Constructs a Domain with no details and no interface to the database.
public  Domain(AbstractDataStoreInterface dsi)
     Constructs a Domain with an interface to the database.
public  Domain(AbstractDataStoreInterface dsi, String sClassName)
     Constructs a Domain with an interface to the database with a class name restriction.
public  Domain(AbstractDataStoreInterface dsi, int nId)
     Constructs a known Domain from an id.

Method Summary
public  voidaddContentTypeRestriction(String sContentType)
     Adds a content type restriction to this domain.
public  voidaddDetails(String sDetails)
     Adds a path restriction to this domain.
public  Objectclone()
    
public  voiddelete()
     Deletes this domain from the database.
public  booleanequals(Object obj)
    
public static  ListgetAvailableProperties(AbstractDataStoreInterface dsi, Class clss)
     Returns a List of Property definitions which can be applied to objects of the specified Class.
public static  ListgetAvailableProperties(AbstractDataStoreInterface dsi, Class clss, String sPath)
     Returns a List of Property definitions which can be applied to the object of the specified Class and path.
public static  ListgetAvailableProperties(AbstractDataStoreInterface dsi, Class clss, List paths)
     Returns a List of Property definitions which can be applied to the objects of the specified Class and paths.
public static  ListgetAvailableProperties(AbstractDataStoreInterface dsi, AbstractProfiledObject profObj)
     Returns a List of Property objects which are allowed to be applied to the specified AbstractProfiledObject.
protected static  ColumnRefgetColumnRef(String sCol, boolean bIsHist)
     Returns the appropriate ColumnRef for the given column name from the Domain database table.
public  ListgetContentRestrictions()
     Returns the list of content restrictions on this domain.
public  intgetDepth()
     Returns the depth restiction on this domain.
public  ListgetDetails()
     Returns the list of path restrictions for this domain.
protected static  ColumnRefgetDetailsColumnRef(String sCol, boolean bIsHist)
     Returns the appropriate ColumnRef for the given column name from the Domain domain details database table.
public  StringgetDomainClass()
     Returns the name of the Class restriction for this domain.
public  intgetId()
     Returns the id of this domain.
public  intgetMaxOccurs()
     Returns the maximum occurance limit for the property on this domain.
public  intgetMinOccurs()
     Returns the minimum occurance limit for the property on this domain.
public  StringgetTagName()
    
public  booleanisChanged()
     Returns true if this domain has changed since being populated from the database.
public  booleanisValid(AbstractProfiledObject obj)
     Returns true if the specified object is a member of this domain and therefore can have an instance of the Property associated to this domain applied to it, otherwise false.
public  voidmarkAsNew()
     Marks this domain as new.
public  voidpopulate(Element xmlElement, State state)
    
public  Elementpublish(Template template, HarmoniseOutput output, State state)
    
public  Elementpublish(Element topEl, HarmoniseOutput output, State state)
    
public  voidsave(Property prop)
     Saves the domain data for this property to the database.
public  voidsetDepth(int nDepth)
     Sets the depth of this domain.
public  voidsetDomainClass(String objectName)
     Sets the Class restriction for this domain.
public  voidsetHistorical(boolean bIsHist)
     Sets whether this domain is historical.
public  voidsetId(int nId)
     Sets the id of this domain.
public  voidsetMaxOccurs(int nMaxOccurs)
     Sets the maximum occurance limit for the property on this domain.
public  voidsetMinOccurs(int nMinOccurs)
     Sets the minimum occurance limit for the property on this domain.

Field Detail
ATTRIB_DEPTH
final public static String ATTRIB_DEPTH(Code)
Depth attribute name



ATTRIB_MAX_OCCURS
final public static String ATTRIB_MAX_OCCURS(Code)
Maximum occurance attribute name



ATTRIB_MIN_OCCURS
final public static String ATTRIB_MIN_OCCURS(Code)
Minimum occurance attribute name



CLMN_CONTENT_TYPE
final public static String CLMN_CONTENT_TYPE(Code)
Content type database column name



CLMN_DEPTH
final public static String CLMN_DEPTH(Code)
Depth database column name



CLMN_DETAILS_DOMAIN_ID
final public static String CLMN_DETAILS_DOMAIN_ID(Code)
Domain id database column name in the domain detail table



CLMN_DOMAIN_DETAILS
final public static String CLMN_DOMAIN_DETAILS(Code)
Domain details database column name.



CLMN_DOMAIN_ID
final public static String CLMN_DOMAIN_ID(Code)
Domain id database column name



CLMN_DOMAIN_OBJECT
final public static String CLMN_DOMAIN_OBJECT(Code)
Domain object database column name



CLMN_MAX_OCCURS
final public static String CLMN_MAX_OCCURS(Code)
Maximum occurance databse column name



CLMN_MIN_OCCURS
final public static String CLMN_MIN_OCCURS(Code)
Minimum occurance database column name



CLMN_PROPERTY_KEY
final public static String CLMN_PROPERTY_KEY(Code)
Property key database column name



SEQ_DOMAIN
final public static String SEQ_DOMAIN(Code)
Domain id database sequence name



TAG_CONTENT_RESTRICTIONS
final public static String TAG_CONTENT_RESTRICTIONS(Code)
Domain details tag name



TAG_DOMAIN
final public static String TAG_DOMAIN(Code)
Domain tag name



TAG_DOMAIN_DETAILS
final public static String TAG_DOMAIN_DETAILS(Code)
Domain details tag name



TAG_DOMAIN_OBJECT
final public static String TAG_DOMAIN_OBJECT(Code)
Domain object tag name



TAG_PATH
final public static String TAG_PATH(Code)
Domain details tag name



TAG_PATHRESTRICTION
public String TAG_PATHRESTRICTION(Code)
Path restriction XML tag name



TBL_DOMAIN_CONTENT_RESTRICTIONS
final public static String TBL_DOMAIN_CONTENT_RESTRICTIONS(Code)
Domain content restrictions database table name



TBL_DOMAIN_DETAILS
final public static String TBL_DOMAIN_DETAILS(Code)
Domain details database column name



TBL_NAME
final public static String TBL_NAME(Code)
Domain database table name



UNBOUNDED
final public static int UNBOUNDED(Code)
int constant for representing an unbounded value



m_child_parent_mappings
public static Map m_child_parent_mappings(Code)
Map of child class to parent classes. Used to cache info.




Constructor Detail
Domain
public Domain()(Code)
Constructs a Domain with no details and no interface to the database.



Domain
public Domain(AbstractDataStoreInterface dsi)(Code)
Constructs a Domain with an interface to the database.
Parameters:
  dsi - the data store interface



Domain
public Domain(AbstractDataStoreInterface dsi, String sClassName)(Code)
Constructs a Domain with an interface to the database with a class name restriction.
Parameters:
  dsi - the data store interface
Parameters:
  sClassName - the class name restriction



Domain
public Domain(AbstractDataStoreInterface dsi, int nId)(Code)
Constructs a known Domain from an id.
Parameters:
  dsi - the data store interface
Parameters:
  nId - the domain id




Method Detail
addContentTypeRestriction
public void addContentTypeRestriction(String sContentType) throws PopulateException(Code)
Adds a content type restriction to this domain.
Parameters:
  sDetails - the content type restriction to add
throws:
  PopulateException - if an error occurs populating this object



addDetails
public void addDetails(String sDetails) throws PopulateException(Code)
Adds a path restriction to this domain.
Parameters:
  sDetails - the path restriction to add if an error occurs populating this domain



clone
public Object clone() throws CloneNotSupportedException(Code)



delete
public void delete() throws EditException(Code)
Deletes this domain from the database.
throws:
  EditException - if an error occurs deleting this domain fromthe database



equals
public boolean equals(Object obj)(Code)



getAvailableProperties
public static List getAvailableProperties(AbstractDataStoreInterface dsi, Class clss) throws DataAccessException(Code)
Returns a List of Property definitions which can be applied to objects of the specified Class.
Parameters:
  dsi - the data store interface
Parameters:
  clss - the Class a List of Property objects
throws:
  DataAccessException - if an error occurs querying the data store



getAvailableProperties
public static List getAvailableProperties(AbstractDataStoreInterface dsi, Class clss, String sPath) throws DataAccessException(Code)
Returns a List of Property definitions which can be applied to the object of the specified Class and path.
Parameters:
  dsi - the data store interface
Parameters:
  clss - the Class
Parameters:
  sPath - the path of an object of the specified Class a List of Property objects
throws:
  DataAccessException - if an error occurs querying the data store



getAvailableProperties
public static List getAvailableProperties(AbstractDataStoreInterface dsi, Class clss, List paths) throws DataAccessException(Code)
Returns a List of Property definitions which can be applied to the objects of the specified Class and paths.
Parameters:
  dsi - the data store interface
Parameters:
  clss - the Class
Parameters:
  paths - the list of paths a List of Property objects
throws:
  DataAccessException - if an error occurs querying the data store



getAvailableProperties
public static List getAvailableProperties(AbstractDataStoreInterface dsi, AbstractProfiledObject profObj) throws DataAccessException(Code)
Returns a List of Property objects which are allowed to be applied to the specified AbstractProfiledObject.
Parameters:
  dsi - the data store interface
Parameters:
  profObj - the profiled object a applicable List of Property objects
throws:
  DataAccessException - if an error occurs querying the data store



getColumnRef
protected static ColumnRef getColumnRef(String sCol, boolean bIsHist) throws DataStoreException(Code)
Returns the appropriate ColumnRef for the given column name from the Domain database table.
Parameters:
  sCol - the column name
Parameters:
  bIsHist - true if the column references the historical the appropriate ColumnRef
throws:
  DataStoreException - if the referenced column is invalid



getContentRestrictions
public List getContentRestrictions() throws DataAccessException(Code)
Returns the list of content restrictions on this domain. the list of content restrictions on this domain
throws:
  DataAccessException - if an error occurs populating thisdomain



getDepth
public int getDepth()(Code)
Returns the depth restiction on this domain. the depth restiction on this domain



getDetails
public List getDetails() throws DataAccessException(Code)
Returns the list of path restrictions for this domain. the list of path restrictions for this domain.
throws:
  DataAccessException - if an error occurs populatingthe data from the database



getDetailsColumnRef
protected static ColumnRef getDetailsColumnRef(String sCol, boolean bIsHist) throws DataStoreException(Code)
Returns the appropriate ColumnRef for the given column name from the Domain domain details database table.
Parameters:
  sCol - the column name
Parameters:
  bIsHist - true if the column references the historicaldatabase table the appropriate ColumnRef
throws:
  DataStoreException - if the referenced column is invalid



getDomainClass
public String getDomainClass()(Code)
Returns the name of the Class restriction for this domain. the name of the Class restriction for this domain



getId
public int getId()(Code)
Returns the id of this domain. the id of this domain



getMaxOccurs
public int getMaxOccurs()(Code)
Returns the maximum occurance limit for the property on this domain. Note: A value of -1 signifies an unbounded limit the maximum occurance limit for the property on this domain



getMinOccurs
public int getMinOccurs()(Code)
Returns the minimum occurance limit for the property on this domain. the minimum occurance limit for the property on this domain



getTagName
public String getTagName()(Code)



isChanged
public boolean isChanged()(Code)
Returns true if this domain has changed since being populated from the database. true if this domain has changed



isValid
public boolean isValid(AbstractProfiledObject obj) throws DataAccessException(Code)
Returns true if the specified object is a member of this domain and therefore can have an instance of the Property associated to this domain applied to it, otherwise false.
Parameters:
  obj - the profiled object true if the specified object is a member of this domain



markAsNew
public void markAsNew()(Code)
Marks this domain as new.



populate
public void populate(Element xmlElement, State state) throws PopulateException(Code)



publish
public Element publish(Template template, HarmoniseOutput output, State state) throws PublishException(Code)



publish
public Element publish(Element topEl, HarmoniseOutput output, State state) throws PublishException(Code)



save
public void save(Property prop) throws EditException(Code)
Saves the domain data for this property to the database.
Parameters:
  prop - the Property assocaited to this domain
throws:
  EditException - if an error occurs saving this domain to thedatabase



setDepth
public void setDepth(int nDepth)(Code)
Sets the depth of this domain.
Parameters:
  nId - the depth of this domain



setDomainClass
public void setDomainClass(String objectName)(Code)
Sets the Class restriction for this domain.
Parameters:
  the - name of the Class restriction for this domain



setHistorical
public void setHistorical(boolean bIsHist)(Code)
Sets whether this domain is historical.
Parameters:
  bIsHist - true if this domain is a historical version,otherwise false



setId
public void setId(int nId)(Code)
Sets the id of this domain.
Parameters:
  nId - the id of this domain



setMaxOccurs
public void setMaxOccurs(int nMaxOccurs)(Code)
Sets the maximum occurance limit for the property on this domain.
Parameters:
  nMinOccurs - the maximum occurance limit



setMinOccurs
public void setMinOccurs(int nMinOccurs)(Code)
Sets the minimum occurance limit for the property on this domain.
Parameters:
  nMinOccurs - the minimum occurance limit



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

w_ww__._j___a_v_a__2__s_.__c___o___m | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.