JSlim  


com.gtcgroup.jslim
Class ValidatorServicesVO

java.lang.Object
  extended bycom.gtcgroup.jslim.DocumentPathSuperVO
      extended bycom.gtcgroup.jslim.ServicesSuperVO
          extended bycom.gtcgroup.jslim.ValidatorServicesVO

final class ValidatorServicesVO
extends ServicesSuperVO

This immutable class maintains a collection of ValidatorServiceKeyVO objects each of which represents a service key as defined in a descriptor document.

Copyright (c) 1999 - 2004 by Global Technology Consulting Group, Inc. at gtcGroup.com.
Use is authorized, provided the source is acknowledged by inclusion of this copyright notice.

Since:
v. 1.0
Author:
MDT (MarvinToll@gtcGroup.com)

Field Summary
private  int intProblemCount
          The number of validation errors detected in the descriptor document(s).
private  java.util.LinkedHashMap lhmValidatorServiceKeyVOs
          A collection of immutable ValidatorServiceKeyVO objects.
 
Constructor Summary
(package private) ValidatorServicesVO()
          Constructor.
private ValidatorServicesVO(int intDocumentPath, int intServiceType, java.lang.String strServiceKey, java.lang.String strElementKey, java.lang.String strElementText, java.util.LinkedHashMap lhmValidatorElementStatusVOs, int intProblemCount)
          Constructor (internal use only).
 
Method Summary
(package private)  boolean containsValidatorServiceKeyVO(int strServiceType, java.lang.String strServiceKey)
          Determines whether or not the collection contains a ValidatorServiceKeyVO.
 boolean equals(java.lang.Object o)
           
(package private)  int getDocumentPath()
          Returns the path representation of the descriptor document.
(package private)  java.lang.String getElementKey()
          Returns the element key representation read from a descriptor document.
(package private)  java.lang.String getElementText()
          Return the element text read from a descriptor document.
(package private)  int getErrorCount()
          Returns the number of validation errors detected in the descriptor document(s).
(package private)  java.lang.String getServiceKey()
          Returns the service key representation read from a descriptor document.
(package private)  int getServiceType()
          Returns the service type representation read from a descriptor document.
(package private)  ValidatorServiceKeyVO getValidatorServiceKeyVO(java.lang.String strConcatenatedKey)
          Returns a ValidatorServiceKeyVO using a concatenated key consisting of the service type and service key.
(package private)  java.util.LinkedHashMap getValidatorServiceKeyVOs()
          Returns the collection of all ValidatorServiceKeyVOs each of which represents a service type defined in a descriptor document.
 int hashCode()
           
(package private)  ValidatorServicesVO incrementProblemCount()
          Returns a new ValidatorServicesVO with an incremented problem counter.
(package private)  ValidatorServicesVO updateDocumentPath(int intDocumentPath)
          Returns an updated ValidatorServicesVO with a revised representation of the descriptor document path.
(package private)  ValidatorServicesVO updateElementKey(java.lang.String strElementKey)
          Returns an updated ValidatorServicesVO with a revised element key from a descriptor document.
(package private)  ValidatorServicesVO updateElementText(java.lang.String strElementText)
          Returns an updated ValidatorServicesVO with a revised element key from a descriptor document.
(package private)  ValidatorServicesVO updateServiceKey(java.lang.String strServiceKey)
          Returns an updated ValidatorServicesVO with a revised element key from a descriptor document.
(package private)  ValidatorServicesVO updateServiceType(int intServiceType)
          Returns an updated ValidatorServicesVO with a revised representation of the descriptor document path.
(package private)  ValidatorServicesVO updateValidatorServiceKeyVO(ValidatorServiceKeyVO validatorServiceKeyVO)
          Adds (or replaces) a new ValidatorServiceKeyVO to the collection.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

lhmValidatorServiceKeyVOs

private final java.util.LinkedHashMap lhmValidatorServiceKeyVOs
A collection of immutable ValidatorServiceKeyVO objects.


intProblemCount

private final int intProblemCount
The number of validation errors detected in the descriptor document(s).

Constructor Detail

ValidatorServicesVO

ValidatorServicesVO()
Constructor.


ValidatorServicesVO

private ValidatorServicesVO(int intDocumentPath,
                            int intServiceType,
                            java.lang.String strServiceKey,
                            java.lang.String strElementKey,
                            java.lang.String strElementText,
                            java.util.LinkedHashMap lhmValidatorElementStatusVOs,
                            int intProblemCount)
Constructor (internal use only).

Parameters:
intDocumentPath - Represents the service type read from a descriptor document.
intServiceType - Represents the service type read from a descriptor document.
strServiceKey - Represents the service key read from a descriptor document.
strElementKey - Represents an element key from a descriptor document.
strElementText - The text from a <Element> element read from a descriptor document.
lhmValidatorElementStatusVOs - A collection of immutable ValidatorServiceKeyVO objects.
intProblemCount - The number of validation errors detected in the descriptor document(s).
Method Detail

containsValidatorServiceKeyVO

final boolean containsValidatorServiceKeyVO(int strServiceType,
                                            java.lang.String strServiceKey)
Determines whether or not the collection contains a ValidatorServiceKeyVO.

Parameters:
strServiceType - Represents the service type read from a descriptor document.
strServiceKey - Represents the service key read from a descriptor document.
Returns:
Whether or not the collection contains a ValidatorServiceKeyVO.

getValidatorServiceKeyVOs

final java.util.LinkedHashMap getValidatorServiceKeyVOs()
Returns the collection of all ValidatorServiceKeyVOs each of which represents a service type defined in a descriptor document.

Returns:
The collection of all ValidatorServiceKeyVOs.

getValidatorServiceKeyVO

final ValidatorServiceKeyVO getValidatorServiceKeyVO(java.lang.String strConcatenatedKey)
                                              throws JSlimException
Returns a ValidatorServiceKeyVO using a concatenated key consisting of the service type and service key.

Parameters:
strConcatenatedKey - A combination of the service type and service key.
Returns:
A ValidatorServiceKeyVO.
Throws:
JSlimException - if an exception encountered.

getErrorCount

final int getErrorCount()
Returns the number of validation errors detected in the descriptor document(s).

Returns:
The number of validation errors detected in the descriptor document(s).

incrementProblemCount

final ValidatorServicesVO incrementProblemCount()
Returns a new ValidatorServicesVO with an incremented problem counter.

Returns:
A new ValidatorServicesVO with an incremented problem counter.

updateDocumentPath

final ValidatorServicesVO updateDocumentPath(int intDocumentPath)
Returns an updated ValidatorServicesVO with a revised representation of the descriptor document path.

Parameters:
intDocumentPath - Represents the path of a descriptor document.
Returns:
An updated ValidatorServicesVO.

updateElementText

final ValidatorServicesVO updateElementText(java.lang.String strElementText)
Returns an updated ValidatorServicesVO with a revised element key from a descriptor document.

Parameters:
strElementText - The text from a <Element> element read from a descriptor document.
Returns:
An updated ValidatorServicesVO.

updateServiceKey

final ValidatorServicesVO updateServiceKey(java.lang.String strServiceKey)
Returns an updated ValidatorServicesVO with a revised element key from a descriptor document.

Parameters:
strServiceKey - Represents the service key read from a descriptor document.
Returns:
An updated ValidatorServicesVO.

updateServiceType

final ValidatorServicesVO updateServiceType(int intServiceType)
Returns an updated ValidatorServicesVO with a revised representation of the descriptor document path.

Parameters:
intServiceType - Represents the service type read from a descriptor document.
Returns:
An updated ValidatorServicesVO.

updateValidatorServiceKeyVO

final ValidatorServicesVO updateValidatorServiceKeyVO(ValidatorServiceKeyVO validatorServiceKeyVO)
Adds (or replaces) a new ValidatorServiceKeyVO to the collection.

Parameters:
validatorServiceKeyVO - Objects representing a service key as defined in the descriptor document.
Returns:
An updated ValidatorServicesVO.

updateElementKey

final ValidatorServicesVO updateElementKey(java.lang.String strElementKey)
Returns an updated ValidatorServicesVO with a revised element key from a descriptor document.

Parameters:
strElementKey - Represents an element key from a descriptor document.
Returns:
An updated ValidatorServicesVO.

equals

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

hashCode

public int hashCode()
Overrides:
hashCode in class ServicesSuperVO

getServiceType

final int getServiceType()
Returns the service type representation read from a descriptor document.

Returns:
The service type representation.

getServiceKey

final java.lang.String getServiceKey()
Returns the service key representation read from a descriptor document.

Returns:
The service key representation.

getElementKey

final java.lang.String getElementKey()
Returns the element key representation read from a descriptor document.

Returns:
The element key representation.

getElementText

final java.lang.String getElementText()
Return the element text read from a descriptor document.

Returns:
The element text read from a descriptor document.

getDocumentPath

final int getDocumentPath()
Returns the path representation of the descriptor document.

Returns:
The path representation of the descriptor document.

JSlim  


Copyright (c) 1999 - 2004 by Global Technology Consulting Group, Inc. at gtcGroup.com.
Use is authorized, provided the source is acknowledged by inclusion of this copyright notice.