| java.lang.Object org.openharmonise.rm.resources.AbstractObject org.openharmonise.rm.resources.AbstractEditableObject org.openharmonise.rm.resources.AbstractProfiledObject org.openharmonise.rm.resources.AbstractChildObject org.openharmonise.rm.resources.metadata.properties.Property
All known Subclasses: org.openharmonise.rm.resources.workflow.properties.WorkflowProperty,
Property | public class Property extends AbstractChildObject implements Publishable,Editable,DataStoreObject,Cloneable(Code) | | Class which represents a metadata property in the Harmonise framework, having
a Range which determines what values an instance of this
Property may have and a set of Domain s which
determine what objects may have an instance of this Property .
author: Michael Bell version: $Revision: 1.5 $ |
ATTRIB_DESCRIPTION | final public static String ATTRIB_DESCRIPTION(Code) | | The description XML attribute name
|
ATTRIB_OPERATOR | final public static String ATTRIB_OPERATOR(Code) | | The operator XML attribute name
|
TAG_DOMAIN_LIST | final public static String TAG_DOMAIN_LIST(Code) | | The domain list XML element name
|
TAG_PROPERTY | final public static String TAG_PROPERTY(Code) | | The property XML element name
|
TYPE_PROPERTY | protected static String TYPE_PROPERTY(Code) | | The constant value for the type field for Property
|
m_add_domains | protected List m_add_domains(Code) | | The List of Domain s that have to be added
at the next save operation
|
m_bIsDomainPopulated | protected boolean m_bIsDomainPopulated(Code) | | boolean flag to indicate whether the List of
Domain s has been populated
|
m_domains | protected List m_domains(Code) | | The List of Domain s for this Property
|
m_range | protected Range m_range(Code) | | The Range for this Property
|
m_remove_domains | protected List m_remove_domains(Code) | | The List of Domain s that have to be removed
at the next save operation
|
Property | public Property()(Code) | | Constructs a new Property
|
Property | public Property(AbstractDataStoreInterface dbintrf)(Code) | | Constructs a Property with an interface to the data store.
Parameters: dbintrf - the data store interface |
Property | public Property(AbstractDataStoreInterface dbintrf, int nId)(Code) | | Constructs a known existing Property with an interface to the
data store.
Parameters: dbintrf - the data store interface Parameters: nId - the id of the Property |
Property | public Property(AbstractDataStoreInterface dbintrf, int nId, int nKey, boolean bIsHist)(Code) | | Constructs Property with the specified id and unique key
which may be historical.
Parameters: dbintrf - the data store interface Parameters: nId - the Property id Parameters: nKey - the unique key of the Property Parameters: bIsHist - true if the Property is to bea historical version |
addDomain | public void addDomain(Domain domain) throws PopulateException(Code) | | Adds the given Domain to this Property .
Parameters: domain - the Domain to add throws: PopulateException - if there is an error populating the domainsfrom the database |
checkDomainAndRange | protected void checkDomainAndRange(Domain domain) throws EditException(Code) | | Checks domain had valid data given the current property range.
Parameters: domain - the domain to check throws: EditException - if an error occurs |
getDomain | public Domain getDomain(AbstractProfiledObject profObj) throws DataAccessException(Code) | | Returns the Domain of this Property which
matches the specified AbstractProfiledObject .
Parameters: profObj - the profiled object the Domain which matches the specified AbstractProfiledObject throws: DataAccessException - if an error occurs populating the listof Domain s |
getDomains | public List getDomains() throws DataAccessException(Code) | | Returns the list of domain restrictions on this Property .
the list of domain restrictions on this Property throws: DataAccessException - if there is an error populating the domainsfrom the database |
getParentObjectClassName | public String getParentObjectClassName()(Code) | | |
isValidProfiledObject | public boolean isValidProfiledObject(AbstractProfiledObject obj) throws DataAccessException(Code) | | Returns true if the specified
AbstarctProfiledObject can have an instance of this
Property in its Profile .
Parameters: obj - the profiled object true if this Property can be applied to the specified profiled object throws: DataAccessException - if an error occurs populating the Domain sof this Property |
populateDomainFromDatabase | protected synchronized void populateDomainFromDatabase() throws PopulateException(Code) | | Populates the list of Domain s from the database for this
Property .
throws: PopulateException - if there is an error populating the datafrom the database |
removeDomain | public void removeDomain(Domain domain) throws PopulateException(Code) | | Removes the given Domain from this Property .
Parameters: domain - the Domain to remove throws: PopulateException - if an error occurs populating the listof Domain s |
setDomains | public void setDomains(List domains) throws PopulateException(Code) | | Sets the complete list of Domain s for this Property ,
overwriting the current list
Parameters: domains - the list of new Domain s throws: PopulateException - if there is an error populating the list ofDomain s |
setHistorical | public void setHistorical(boolean bIsHistorical)(Code) | | |
setRange | public void setRange(Range range) throws PopulateException(Code) | | Sets the Range for this Property .
Parameters: range - the Range for this Property throws: PopulateException - if an error occurs populating this Property |
Methods inherited from org.openharmonise.rm.resources.AbstractChildObject | protected void addColumnsToPopulateQuery(SelectStatement select, boolean bIsHist) throws DataStoreException(Code)(Java Doc) protected void addDataToSave(InsertStatement insert) throws DataStoreException(Code)(Java Doc) protected void addParent(AbstractParentObject group) throws PopulateException(Code)(Java Doc) public Editable archive() throws EditException(Code)(Java Doc) public Editable changeStatus(Status status) throws EditException(Code)(Java Doc) public void clear()(Code)(Java Doc) public Object clone()(Code)(Java Doc) protected AbstractParentObject createGroupFromPath(String sFullPath) throws EditException(Code)(Java Doc) protected void delete(boolean bDeleteHist) throws DataStoreException, DataAccessException, EditException, PopulateException(Code)(Java Doc) protected void fullPopulate() throws PopulateException(Code)(Java Doc) public List getAllFullPaths() throws DataAccessException(Code)(Java Doc) public List getAllPaths() throws DataAccessException(Code)(Java Doc) public static ColumnRef getColumnRef(String sClassname, String sColumn, boolean bHist) throws DataStoreException(Code)(Java Doc) public String getFullPath() throws DataAccessException(Code)(Java Doc) public ColumnRef getInstanceColumnRef(String sColumn, boolean bIsHist) throws DataStoreException(Code)(Java Doc) public static ColumnRef getObjectColumnRef(String sTable, String sColumn) throws DataStoreException(Code)(Java Doc) protected ColumnRef getParentChildJoinColumnRef(String sCol) throws DataStoreException(Code)(Java Doc) abstract public String getParentObjectClassName()(Code)(Java Doc) public static String getParentObjectClassName(String sChildClassname) throws DataAccessException(Code)(Java Doc) public List getParents() throws DataAccessException(Code)(Java Doc) public String getPath() throws DataAccessException(Code)(Java Doc) public AbstractParentObject getRealParent() throws DataAccessException(Code)(Java Doc) public boolean isChanged() throws DataAccessException(Code)(Java Doc) public boolean isRealParent(AbstractParentObject obj) throws DataAccessException(Code)(Java Doc) public void markAsNew() throws PopulateException(Code)(Java Doc) public void populate(Element xmlElement, State state) throws PopulateException(Code)(Java Doc) protected void populateFromResultSetRow(ResultSet rs, SelectStatement select) throws PopulateException(Code)(Java Doc) protected void populateGroupsFromDatabase() throws PopulateException(Code)(Java Doc) public org.w3c.dom.Element publish(Element topEl, HarmoniseOutput xmlDoc, State state) throws PublishException(Code)(Java Doc) public Editable reactivate() throws EditException(Code)(Java Doc) protected void removeParent(AbstractParentObject group) throws PopulateException(Code)(Java Doc) protected void saveCoreData() throws EditException(Code)(Java Doc) protected void setRealParent(AbstractParentObject group) throws PopulateException(Code)(Java Doc) protected void update() throws EditException, DataStoreException(Code)(Java Doc) protected void updateParents() throws EditException(Code)(Java Doc)
|
Methods inherited from org.openharmonise.rm.resources.AbstractProfiledObject | protected void addColumnsToPopulateQuery(SelectStatement select, boolean bIsHist) throws DataStoreException(Code)(Java Doc) public void addProfile(Profile profile) throws InvalidProfileException(Code)(Java Doc) public Editable changeStatus(Status status) throws EditException(Code)(Java Doc) public void clear()(Code)(Java Doc) public Object clone()(Code)(Java Doc) protected void delete(boolean bDeleteHistory) throws DataStoreException, DataAccessException, EditException, PopulateException(Code)(Java Doc) protected void fillProfiles() throws PopulateException(Code)(Java Doc) protected void fullPopulate() throws PopulateException(Code)(Java Doc) public int getNumProfiles() throws DataAccessException(Code)(Java Doc) public Profile getProfile() throws DataAccessException(Code)(Java Doc) public Profile getProfile(String sName) throws DataAccessException(Code)(Java Doc) public List getProfiles() throws DataAccessException(Code)(Java Doc) public Map getProfilesMap() throws DataAccessException(Code)(Java Doc) public AbstractPropertyInstance getPropertyInstance(String sPropName) throws InvalidPropertyInstanceException, DataAccessException(Code)(Java Doc) public AbstractPropertyInstance getPropertyInstance(Property prop) throws InvalidPropertyInstanceException, DataAccessException(Code)(Java Doc) public void ignoreProfileRestrictions(boolean bIgnore)(Code)(Java Doc) public boolean isChanged() throws DataAccessException(Code)(Java Doc) public boolean isDefaultProfile(Profile prof)(Code)(Java Doc) protected boolean isProfileLoaded(String sName)(Code)(Java Doc) public void markAsNew() throws PopulateException(Code)(Java Doc) public void populate(Element xmlElement, State state) throws PopulateException(Code)(Java Doc) protected void populateFromResultSetRow(ResultSet rs, SelectStatement select) throws PopulateException(Code)(Java Doc) public List processResultSet(CachedResultSet rs, SelectStatement select)(Code)(Java Doc) public List processResultSet(CachedResultSet rs, SelectStatement select, int nLimit)(Code)(Java Doc) public Element publish(Element topEl, HarmoniseOutput xmlDoc, State state) throws PublishException(Code)(Java Doc) public void removeProfile(String sProfile) throws DataAccessException(Code)(Java Doc) protected void saveCoreData() throws EditException(Code)(Java Doc) protected void setDefaultProfile(String sName) throws InvalidProfileException, DataAccessException(Code)(Java Doc) public void setHistorical(boolean bIsHistorical)(Code)(Java Doc) public void setProfile(Profile profile) throws InvalidProfileException(Code)(Java Doc) protected void setProfiles(List profiles) throws InvalidProfileException(Code)(Java Doc) protected void setProfiles(Map profiles)(Code)(Java Doc) protected void setProfilesHistorical(boolean bIsHistorical)(Code)(Java Doc) public String toString()(Code)(Java Doc) protected void update() throws DataStoreException, EditException(Code)(Java Doc)
|
Methods inherited from org.openharmonise.rm.resources.AbstractEditableObject | public void acquireEditWriteLock() throws EditException(Code)(Java Doc) protected void addColumnsToPopulateQuery(SelectStatement select, boolean bIsHist) throws DataStoreException(Code)(Java Doc) protected void addDataToSave(InsertStatement insert) throws DataStoreException(Code)(Java Doc) public void addEditEventListener(EditEventListener listener)(Code)(Java Doc) public Editable archive() throws EditException(Code)(Java Doc) public Editable changeStatus(Status status) throws EditException(Code)(Java Doc) public void clear()(Code)(Java Doc) public Object clone()(Code)(Java Doc) public Editable createNewVersion() throws EditException(Code)(Java Doc) protected void delete(boolean bDeleteHist) throws DataStoreException, DataAccessException, EditException, PopulateException(Code)(Java Doc) public List getAllVersions() throws DataAccessException(Code)(Java Doc) public static ColumnRef getColumnRef(String sClassname, String sColumn, boolean bHist) throws DataStoreException(Code)(Java Doc) public String getDisplayName() throws DataAccessException(Code)(Java Doc) public List getHistoricalVersions() throws DataAccessException(Code)(Java Doc) public java.util.Date getHistoryDate() throws DataAccessException(Code)(Java Doc) public ColumnRef getInstanceColumnRef(String sColumn, boolean bIsHist) throws DataStoreException(Code)(Java Doc) public Editable getLiveVersion() throws DataAccessException(Code)(Java Doc) public User getLockOwner() throws DataAccessException(Code)(Java Doc) public int getLockUserId() throws DataAccessException(Code)(Java Doc) public static ColumnRef getObjectColumnRef(String sTable, String sColumn) throws DataStoreException(Code)(Java Doc) public List getPendingVersions() throws DataAccessException(Code)(Java Doc) public Status getStatus() throws DataAccessException(Code)(Java Doc) public String getVersionComment() throws DataAccessException(Code)(Java Doc) public java.util.Date getVersionDate() throws DataAccessException(Code)(Java Doc) public int getVersionNumber() throws DataAccessException(Code)(Java Doc) protected boolean isKeySupported()(Code)(Java Doc) public boolean isLiveVersion() throws DataAccessException(Code)(Java Doc) protected boolean isLockThread()(Code)(Java Doc) public boolean isLocked() throws DataAccessException(Code)(Java Doc) public boolean isPendingVersion() throws DataAccessException(Code)(Java Doc) public synchronized void lock(User usr) throws EditException(Code)(Java Doc) public void populate(Element xmlElement, State state) throws PopulateException(Code)(Java Doc) protected void populateFromResultSetRow(ResultSet rs, SelectStatement select) throws PopulateException(Code)(Java Doc) public Element publish(Element topEl, HarmoniseOutput xmlDoc, State state) throws PublishException(Code)(Java Doc) public Editable reactivate() throws EditException(Code)(Java Doc) public void releaseEditWriteLock()(Code)(Java Doc) public void removeEditEventListener(EditEventListener listener)(Code)(Java Doc) public Editable save() throws EditException(Code)(Java Doc) abstract protected void saveCoreData() throws EditException(Code)(Java Doc) abstract protected void saveNonCoreData() throws EditException(Code)(Java Doc) public void setDisplayName(String sDisplayName)(Code)(Java Doc) public void setVersionComment(String sVersionComment)(Code)(Java Doc) public void unlock(User usr) throws EditException(Code)(Java Doc) protected void update() throws DataStoreException, EditException(Code)(Java Doc) protected void updateDBStatus() throws PopulateException(Code)(Java Doc) public void workflowObjectArchived(EditEvent event)(Code)(Java Doc) public void workflowObjectLocked(EditEvent event)(Code)(Java Doc) public void workflowObjectReactivated(EditEvent event)(Code)(Java Doc) public void workflowObjectSaved(EditEvent event)(Code)(Java Doc) public void workflowObjectStatusChanged(EditEvent event)(Code)(Java Doc) public void workflowObjectUnlocked(EditEvent event)(Code)(Java Doc)
|
Methods inherited from org.openharmonise.rm.resources.AbstractObject | public void addCacheListener(CacheListener listener)(Code)(Java Doc) protected void addColumnsToPopulateQuery(SelectStatement select, boolean bIsHist) throws DataStoreException(Code)(Java Doc) public void clear()(Code)(Java Doc) public Object clone()(Code)(Java Doc) public int compareTo(Object obj)(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) public boolean exists()(Code)(Java Doc) protected void fullPopulate() throws PopulateException(Code)(Java Doc) public List getCacheListeners()(Code)(Java Doc) public static ColumnRef getColumnRef(AbstractObject obj, String sColumn) throws DataStoreException(Code)(Java Doc) public static ColumnRef getColumnRef(String sClassname, String sColumn) throws DataStoreException(Code)(Java Doc) public static ColumnRef getColumnRef(String sClassname, String sColumn, boolean bHist) throws DataStoreException(Code)(Java Doc) protected static Collection getCoreColumnRefs(String sClassname) throws DataStoreException(Code)(Java Doc) abstract public String getDBTableName()(Code)(Java Doc) public AbstractDataStoreInterface getDataStoreInterface()(Code)(Java Doc) protected String getHistoricalDBTableName()(Code)(Java Doc) public int getId()(Code)(Java Doc) public ColumnRef getInstanceColumnRef(String sColumn, boolean bIsHist) throws DataStoreException(Code)(Java Doc) public int getKey() throws DataAccessException(Code)(Java Doc) public String getName() throws DataAccessException(Code)(Java Doc) protected static ColumnRef getObjectColumnRef(String sDBTable, String sColumn) throws DataStoreException(Code)(Java Doc) public String getSummary() throws DataAccessException(Code)(Java Doc) public static String getTableName(String sClassname, boolean bHist) throws DataStoreException(Code)(Java Doc) protected String getTableName(boolean bIsHist)(Code)(Java Doc) public String getType() throws DataAccessException(Code)(Java Doc) public int hashCode()(Code)(Java Doc) public boolean isChanged() throws DataAccessException(Code)(Java Doc) public boolean isHistorical()(Code)(Java Doc) abstract protected boolean isKeySupported()(Code)(Java Doc) protected boolean isPopulated()(Code)(Java Doc) protected void markAsNew() throws PopulateException(Code)(Java Doc) public void notifyCacheListeners()(Code)(Java Doc) public void populate(Element xmlElement, State state) throws PopulateException(Code)(Java Doc) protected synchronized void populateFromDatabase() throws PopulateException(Code)(Java Doc) protected void populateFromResultSetRow(ResultSet rs, SelectStatement select) throws PopulateException(Code)(Java Doc) public Element publish(Template template, HarmoniseOutput xmlDoc, State state) throws PublishException(Code)(Java Doc) public Element publish(Element topEl, HarmoniseOutput xmlDoc, State state) throws PublishException(Code)(Java Doc) public void removeCacheListener(CacheListener listener)(Code)(Java Doc) public void setDataStoreInterface(AbstractDataStoreInterface dsi) throws PopulateException(Code)(Java Doc) public void setHistorical(boolean bIsHistorical)(Code)(Java Doc) public void setId(int nId)(Code)(Java Doc) public void setIsChanged(boolean bIsChanged)(Code)(Java Doc) public void setKey(int nKey)(Code)(Java Doc) public void setName(String sName) throws InvalidNameException(Code)(Java Doc) public void setSummary(String sSummary)(Code)(Java Doc) public void setType(String type)(Code)(Java Doc)
|
|
|