cs.arizona.tau.xml
Class Item

java.lang.Object
  extended by cs.arizona.tau.xml.BaseItem
      extended by cs.arizona.tau.xml.Item
All Implemented Interfaces:
java.lang.Cloneable

public class Item
extends BaseItem
implements java.lang.Cloneable

Author:
spjoshi

Field Summary
 
Fields inherited from class cs.arizona.tau.xml.BaseItem
CONTENT_CONSTANT, CONTENT_VARYING, EXISTENCE_CONSTANT, EXISTENCE_VARYING_WITH_GAPS, EXISTENCE_VARYING_WITHOUT_GAPS, KIND_EVENT, KIND_STATE
 
Constructor Summary
Item()
           
Item(org.w3c.dom.Element xmlSchemaElement)
          The constructor accepts an Element from Temporal Annotation and creates a prototype of an item.
Item(org.w3c.dom.Element xmlSchemaElement, boolean dummy)
          Steve testng The constructor accepts an Element from Physical.
Item(Item item)
           
 
Method Summary
 Item cloneItem()
           
 void coalsce(org.w3c.dom.Document temporalDoc, LogicalAnnotationValidator tav, java.lang.String repSchemaNameAlias)
          The function coalsces the versions, so as to form the compact representation.
 boolean equals(java.lang.Object o)
           
 int getContent()
           
 ITimePeriod getContentVaryingApplicabilityPeriod()
           
 int getExistence()
           
 ItemIdentifier getItemIdentifier()
           
 int getKind()
           
 ITimePeriod getMaximalExistencePeriod()
           
 int getTransactionTimeFrequency()
           
 int getValidTimeFrequency()
           
 int hashCode()
           
 boolean isCoalsced()
           
 void setContent(int content)
           
 void setContentVaryingApplicabilityPeriod(ITimePeriod contentVaryingApplicabilityPeriod)
           
 void setExistence(int existence)
           
 void setItemIdentifier(ItemIdentifier itemIdentifier)
           
 void setKind(int kind)
           
 void setMaximalExistencePeriod(ITimePeriod maximalExistencePeriod)
           
 void setTransactionTimeFrequency(int transactionTimeFrequency)
           
 void setValidTimeFrequency(int validTimeFrequency)
           
 RepItem toRepItem(int timeRepresentation)
          Given timeRepresentation, the function converts the given Item to RepItem and returns an instance of RepItem
 java.lang.String toString()
           
 boolean validate(ITime documentExistenceTime, LogicalAnnotationValidator tav, org.w3c.dom.Document temporalDoc)
          The function internally checks all the constraints on the item.
 
Methods inherited from class cs.arizona.tau.xml.BaseItem
addVersion, addVersionAll, clearVersions, createRefElement, getItemID, getSnapshot, getTarget, getTemporalElement, getTimeDimension, getVersion, getVersionCount, getVersionElement, getVersionIterator, getVersions, merge, removeVersion, setItemID, setTarget, setTimeDimension
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Item

public Item()

Item

public Item(Item item)
Parameters:
item -

Item

public Item(org.w3c.dom.Element xmlSchemaElement)
The constructor accepts an Element from Temporal Annotation and creates a prototype of an item. All Versions, TemporalElement and values inside Item Identifier would be undefined. But this item prototype is used by TemporalAnnotationValidator

Parameters:
itemType -
xmlSchemaElement -

Item

public Item(org.w3c.dom.Element xmlSchemaElement,
            boolean dummy)
Steve testng The constructor accepts an Element from Physical.

Parameters:
itemType -
xmlSchemaElement -
Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getContent

public int getContent()
Returns:
Returns the content.

setContent

public void setContent(int content)
Parameters:
content - The content to set.

getExistence

public int getExistence()
Returns:
Returns the existence.

setExistence

public void setExistence(int existence)
Parameters:
existence - The existence to set.

getItemIdentifier

public ItemIdentifier getItemIdentifier()
Returns:
Returns the itemIdentifier.

setItemIdentifier

public void setItemIdentifier(ItemIdentifier itemIdentifier)
Parameters:
itemIdentifier - The itemIdentifier to set.

getKind

public int getKind()
Returns:
Returns the kind.

setKind

public void setKind(int kind)
Parameters:
kind - The kind to set.

isCoalsced

public boolean isCoalsced()
Returns:
Returns the optimized.

getContentVaryingApplicabilityPeriod

public ITimePeriod getContentVaryingApplicabilityPeriod()
Returns:
Returns the contentVaryingApplicabilityPeriod.

setContentVaryingApplicabilityPeriod

public void setContentVaryingApplicabilityPeriod(ITimePeriod contentVaryingApplicabilityPeriod)
Parameters:
contentVaryingApplicabilityPeriod - The contentVaryingApplicabilityPeriod to set.

getMaximalExistencePeriod

public ITimePeriod getMaximalExistencePeriod()
Returns:
Returns the maximalExistencePeriod.

setMaximalExistencePeriod

public void setMaximalExistencePeriod(ITimePeriod maximalExistencePeriod)
Parameters:
maximalExistencePeriod - The maximalExistencePeriod to set.

getTransactionTimeFrequency

public int getTransactionTimeFrequency()
Returns:
Returns the transactionTimeFrequency.

setTransactionTimeFrequency

public void setTransactionTimeFrequency(int transactionTimeFrequency)
Parameters:
transactionTimeFrequency - The transactionTimeFrequency to set.

getValidTimeFrequency

public int getValidTimeFrequency()
Returns:
Returns the validTimeFrequency.

setValidTimeFrequency

public void setValidTimeFrequency(int validTimeFrequency)
Parameters:
validTimeFrequency - The validTimeFrequency to set.

toRepItem

public RepItem toRepItem(int timeRepresentation)
Given timeRepresentation, the function converts the given Item to RepItem and returns an instance of RepItem

Parameters:
timeRepresentation -
Returns:

cloneItem

public Item cloneItem()

coalsce

public void coalsce(org.w3c.dom.Document temporalDoc,
                    LogicalAnnotationValidator tav,
                    java.lang.String repSchemaNameAlias)
The function coalsces the versions, so as to form the compact representation. After coalscing coalsced flag is set to true.


validate

public boolean validate(ITime documentExistenceTime,
                        LogicalAnnotationValidator tav,
                        org.w3c.dom.Document temporalDoc)
The function internally checks all the constraints on the item.

Returns:
true if the item is valid, else return false.

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object