com.apelon.dts.common.subset
Class Subset

java.lang.Object
  com.apelon.dts.common.subset.Subset

public class Subset
extends Object

This class represents the definition of a subset.

A subset expression is a XML representation of DefaultMutableTreeNode created using XMLEncoder. The following table describes the node content and relationship to create the hierarchy which a subset expression represents:

Node	userObject	child
Root	"DTS Concepts"	Namespace Node
Namespace Node	NamespaceFilter	Concept Filter Node, Concept Node, Exclude Node
Concept Filter Node	OntylogConceptFilter with modifier other than ONLY, PropertyFilter, ConceptNameFilter	Concept Filter Node, Concept Node, Exclude Node
Concept Node	OntylogConceptFilter with modifier as ONLY
Exclude Node	"EXCLUDE"	Concept Filter Node, Concept Node

If the Subset is created in SecuredSocket mode, getCreatedBy() returns the DTS user name. If the Subset is modified last using SecuredSocket mode,getModifiedBy() returns the DTS user name.

Copyright: Copyright (c) 2004

Company: Apelon, Inc.

Since:

3.4.0

Version:

DTS 3.4.0

Author:

Apelon Inc.

Constructor Summary

Subset()

Method Summary

int	getConceptCount() Returns the total number of concepts that belong to this subset as of last build.
String	getCreatedBy() Returns the DTS user who created the subset if the Subset is created in secure socket mode.
long	getCreatedTime() Returns the date and time when this subset was created.
long	getDataCreatedTime() Returns the data and time of the last build.
String	getDescription() Returns description of this subset.
String	getExpression() Returns the expression of the Subset.
int	getId() Returns ID of the Subset
String	getModifiedBy() Returns the DTS user who last modifed the subset expression.
long	getModifiedTime() Returns the date and time when the subset expression was modified.
String	getName() Retruns the name of the Subset
void	setConceptCount(int conceptCount) Sets the total number of concepts in this subset.
void	setCreatedBy(String createdBy) Sets the DTS user who creates this subset
void	setCreatedTime(long createdTime) Sets the creation time for the Subset.
void	setDataCreatedTime(long dataCreatedTime) Sets the build time of this subset.
void	setDescription(String description) Sets the description for this subset
void	setExpression(String expression) Sets the expression of the Subset.
void	setId(int id) Sets the ID for this Subset.
void	setModifiedBy(String modifiedBy) Sets the DTS user who modified the subset expression.
void	setModifiedTime(long modifiedTime) Sets the modification time of the subset expression.
void	setName(String name) Sets the name for the Subset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Subset

public Subset()

Method Detail

getId

public int getId()

Returns ID of the Subset

Returns:

int ID

setId

public void setId(int id)

Sets the ID for this Subset. Users are not required to set this field. This is set internally by the server when the subset is added to the knowledgebase.

Parameters:

id - any integer

See Also:

SubsetQuery.add(Subset)

getName

public String getName()

Retruns the name of the Subset

Returns:

String name

setName

public void setName(String name)

Sets the name for the Subset

Parameters:

name -

getExpression

public String getExpression()

Returns the expression of the Subset. Expression is represented as XML string from which DefaultMutableTreeNode can be created using XMLDecoder.

Returns:

String XML String

setExpression

public void setExpression(String expression)

Sets the expression of the Subset.

Subset Expression is XML representation of DefaultMutableTreeNode created using XMLEncoder. See header for details about the rules.

Parameters:

expression -

getCreatedBy

public String getCreatedBy()

Returns the DTS user who created the subset if the Subset is created in secure socket mode.

Returns:

String DTS User name if available, else null

See Also:

ServerConnection

setCreatedBy

public void setCreatedBy(String createdBy)

Sets the DTS user who creates this subset

Parameters:

createdBy - DTS User

getCreatedTime

public long getCreatedTime()

Returns the date and time when this subset was created.

Returns:

long Date and Time

getModifiedBy

public String getModifiedBy()

Returns the DTS user who last modifed the subset expression.

Returns:

String DTS User name if available, else null

setModifiedBy

public void setModifiedBy(String modifiedBy)

Sets the DTS user who modified the subset expression.

Parameters:

modifiedBy - A DTS user name

setCreatedTime

public void setCreatedTime(long createdTime)

Sets the creation time for the Subset.

This method should not be used. This is used internally by the API. Any other calls will be overriden.

Parameters:

createdTime -

getModifiedTime

public long getModifiedTime()

Returns the date and time when the subset expression was modified.

Returns:

long Date and Time

setModifiedTime

public void setModifiedTime(long modifiedTime)

Sets the modification time of the subset expression.

This method should not be used. This is used internally by the API. Any other calls will be overriden.

Parameters:

modifiedTime -

getConceptCount

public int getConceptCount()

Returns the total number of concepts that belong to this subset as of last build.

Returns:

int concept count

setConceptCount

public void setConceptCount(int conceptCount)

Sets the total number of concepts in this subset.

This method should not be used. This is used internally by the API. Any other calls will be overriden.

Parameters:

conceptCount -

getDataCreatedTime

public long getDataCreatedTime()

Returns the data and time of the last build.

Returns:

long data and time

setDataCreatedTime

public void setDataCreatedTime(long dataCreatedTime)

Sets the build time of this subset.

This method should not be used. This is used internally by the API. Any other calls will be overriden.

Parameters:

dataCreatedTime -

getDescription

public String getDescription()

Returns description of this subset.

Returns:

String

setDescription

public void setDescription(String description)

Sets the description for this subset

Parameters:

description -