wt.csm.navigation.service
Class NavigationDBService

java.lang.Object
  extended bywt.services.StandardManager
      extended bywt.csm.navigation.service.NavigationDBService
All Implemented Interfaces:
Manager, NetFactor, Serializable

public class NavigationDBService
extends StandardManager
implements Serializable

Use the newNavigationDBService static factory method(s), not the NavigationDBService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
private static String RESOURCE
           
 
Fields inherited from class wt.services.StandardManager
 
Fields inherited from interface wt.services.Manager
MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE
 
Constructor Summary
NavigationDBService()
           
 
Method Summary
 IndependentNode copyNavigationNode(IndependentNodeNodeView sourceNavigationNode, IndependentNodeNodeView targetParentNavigationNode)
          

Supported API: false
private  void copyNodeQueryForm(IndependentNode newNode, IndependentNode oldNode)
           
 IndependentNode createNavigationNode(IndependentNodeDefaultView navigationNode, AbstractNavStructView navStruct)
          

Supported API: false
 AbstractNavStruct createNavigationStructure(AbstractNavStructView navStruct)
          

Supported API: false
private  void deleteDefaultQueryForm(AbstractQueryTarget target)
           
private  void deleteDirectQueryTarget(AbstractNavStructView navStruct)
           
private  void deleteIndirectQueryTarget(AbstractNavStructView navStruct)
           
 void deleteNavigationNode(IndependentNodeNodeView navigationNode)
          

Supported API: false
 void deleteNavigationStructure(AbstractNavStructView navStruct)
          

Supported API: false
private  void deleteNodeQueryForm(AbstractNode node)
           
private  void deleteQueryFormElement(AbstractQueryForm form)
           
 Vector extractNodesInNavStruct(QueryResult qr, String navStructClassName)
          extractNodesInNavStruct
 Vector extractNodesInSpecifiedParentNode(QueryResult qr, String navStructClassName, AbstractNodeNodeView navParentNode)
           
private  long findClassifiStructIdA3A6BasedOnIdA2A2(long idA2A2)
           
 Vector findNavigationNodes(NavStructListView navStrTarget, String srcForString, String matching, AbstractNodeNodeView navParentNode)
          

Supported API: false
 Vector findNavigationNodes(String structName, String srcForString, String matching, AbstractNodeNodeView navParentNode)
          

Supported API: false
private  AbstractNavStruct findNavStructBasedOnName(String navStructureName)
           
private  QuerySpec formQuerySpec(long navStructId, String navStructClassName, String srcString, String srcPattern)
           
 AbstractNavStruct[] getAllNavigationStructures()
          

Supported API: false
 String getConceptualClassname()
          Deprecated.  
protected  AbstractNode[] getHeavyIndependentNodeChildren(IndependentNode node)
           
 AbstractNode[] getHeavyNavigationNodeChildren(AbstractNode node)
           
 IndirectQueryTarget[] getIndirectQueryTargets(AbstractNavStructView navStruct)
          

Supported API: false
 AbstractNode[] getNavigationNodeChildren(AbstractNodeNodeView node)
          

Supported API: false
 AbstractNode getNavigationNodeDefaultView(AbstractNodeNodeView navigationNode)
          

Supported API: false
 AbstractNode getNavigationNodeFromID(String nodeid)
          

Supported API: false
 AbstractNavStruct getNavigationStructureDefaultView(AbstractNodeDefaultView navigationNode)
          

Supported API: false
 AbstractNavStruct getNavigationStructureDefaultView(NavStructListView navStructListView)
          

Supported API: false
 AbstractNavStruct getNavigationStructureDefaultView(String navStructName)
          

Supported API: false
 AbstractNavStruct getNavigationStructureFromID(String structid)
          

Supported API: false
private  AbstractNode[] getNavigationStructureRootNodes(AbstractNavStructView navStruct)
           
 AbstractNode[] getNavigationStructureRootNodes(NavStructListView navStruct)
          

Supported API: false
 NodeQueryForm[] getNodeQueryForms(AbstractNodeDefaultView navigationNode)
          

Supported API: false
 AbstractNode getParentNodeDefaultView(AbstractNodeDefaultView navigationNode)
          

Supported API: false
 AbstractNode[] getParentNodes(AbstractNodeNodeView navigationNode)
          

Supported API: false
 QueryFormElement[] getQueryFormElements(AbstractQueryFormView queryForm)
          

Supported API: false
private  boolean hasValidLineage(ObjectIdentifier nodeID, IndependentNode parent)
           
private  boolean hasValidName(String sourceName, AbstractNode[] siblings)
           
private  AbstractNavStructView insertIndirectQueryTargetDefaultView(AbstractNavStruct structure)
           
private  AbstractNodeDefaultView insertNodeQueryFormDefaultView(AbstractNode node)
           
private  AbstractQueryFormView insertQueryFormElementDefaultView(AbstractQueryFormView liteForm)
           
private  boolean isValidRoot(AbstractNodeNodeView node)
           
static NavigationDBService newNavigationDBService()
          Default factory for the class.
protected  void performStartupProcess()
          

Supported API: false
private  DirectQueryTarget persistDirectQueryTarget(AbstractNavStructView navStruct)
           
private  void persistIndirectQueryTarget(AbstractNavStructView navStruct, AbstractNavStruct heavyNavStruct)
           
private  void persistNodeQueryForm(AbstractNode persistedNode, AbstractNodeDefaultView node)
           
private  void persistQueryFormElement(AbstractQueryFormView liteForm, AbstractQueryForm form)
           
protected  void recurseCopyNode(IndependentNode parent, AbstractNode[] children)
           
private  void recurseDeleteNavigationNode(AbstractNode[] nodes)
           
protected  void recurseDeleteNode(AbstractNode[] children)
           
 AbstractNode refreshNavigationNodeDefaultView(AbstractNodeDefaultView navigationNode)
          

Supported API: false
 AbstractNode refreshNavigationNodeNodeView(AbstractNodeNodeView navigationNode)
          

Supported API: false
 AbstractNavStruct refreshNavigationStructure(AbstractNavStructView navStruct)
          

Supported API: false
 AbstractNode updateNavigationNode(AbstractNodeDefaultView navigationNode)
          

Supported API: false
 IndependentNode updateNavigationNode(IndependentNodeNodeView navigationNode)
          

Supported API: false
 AbstractNavStruct updateNavigationStructure(AbstractNavStructView navStruct)
          

Supported API: false
 
Methods inherited from class wt.services.StandardManager
emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, registerEvents, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME
Constructor Detail

NavigationDBService

public NavigationDBService()
Method Detail

getConceptualClassname

public String getConceptualClassname()
Deprecated.  

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:
getConceptualClassname in interface NetFactor
Overrides:
getConceptualClassname in class StandardManager
Returns:
String

getAllNavigationStructures

public AbstractNavStruct[] getAllNavigationStructures()
                                               throws CSMClassificationNavigationException,
                                                      WTException


Supported API: false

Returns:
AbstractNavStruct[]
Throws:
CSMClassificationNavigationException
WTException

getNavigationStructureDefaultView

public AbstractNavStruct getNavigationStructureDefaultView(NavStructListView navStructListView)
                                                    throws CSMClassificationNavigationException,
                                                           WTException


Supported API: false

Parameters:
navStructListView -
Returns:
AbstractNavStruct
Throws:
CSMClassificationNavigationException
WTException

getNavigationStructureDefaultView

public AbstractNavStruct getNavigationStructureDefaultView(AbstractNodeDefaultView navigationNode)
                                                    throws CSMClassificationNavigationException,
                                                           WTException


Supported API: false

Parameters:
navigationNode -
Returns:
AbstractNavStruct
Throws:
CSMClassificationNavigationException
WTException

getNavigationStructureDefaultView

public AbstractNavStruct getNavigationStructureDefaultView(String navStructName)
                                                    throws CSMClassificationNavigationException,
                                                           WTException


Supported API: false

Parameters:
navStructName -
Returns:
AbstractNavStruct
Throws:
CSMClassificationNavigationException
WTException

refreshNavigationStructure

public AbstractNavStruct refreshNavigationStructure(AbstractNavStructView navStruct)
                                             throws CSMClassificationNavigationException,
                                                    WTException


Supported API: false

Parameters:
navStruct -
Returns:
AbstractNavStruct
Throws:
CSMClassificationNavigationException
WTException

getIndirectQueryTargets

public IndirectQueryTarget[] getIndirectQueryTargets(AbstractNavStructView navStruct)
                                              throws CSMClassificationNavigationException,
                                                     WTException


Supported API: false

Parameters:
navStruct -
Returns:
IndirectQueryTarget []
Throws:
CSMClassificationNavigationException
WTException

createNavigationStructure

public AbstractNavStruct createNavigationStructure(AbstractNavStructView navStruct)
                                            throws CSMClassificationNavigationException,
                                                   NotAuthorizedException,
                                                   WTException


Supported API: false

Parameters:
navStruct -
Returns:
AbstractNavStruct
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

deleteNavigationStructure

public void deleteNavigationStructure(AbstractNavStructView navStruct)
                               throws CSMClassificationNavigationException,
                                      NotAuthorizedException,
                                      WTException


Supported API: false

Parameters:
navStruct -
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

updateNavigationStructure

public AbstractNavStruct updateNavigationStructure(AbstractNavStructView navStruct)
                                            throws CSMClassificationNavigationException,
                                                   NotAuthorizedException,
                                                   WTException


Supported API: false

Parameters:
navStruct -
Returns:
AbstractNavStruct
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

getNavigationStructureRootNodes

public AbstractNode[] getNavigationStructureRootNodes(NavStructListView navStruct)
                                               throws CSMClassificationNavigationException,
                                                      WTException


Supported API: false

Parameters:
navStruct -
Returns:
AbstractNode[]
Throws:
CSMClassificationNavigationException
WTException

getNavigationNodeChildren

public AbstractNode[] getNavigationNodeChildren(AbstractNodeNodeView node)
                                         throws CSMClassificationNavigationException,
                                                WTException


Supported API: false

Parameters:
node -
Returns:
AbstractNode[]
Throws:
CSMClassificationNavigationException
WTException

getParentNodeDefaultView

public AbstractNode getParentNodeDefaultView(AbstractNodeDefaultView navigationNode)
                                      throws CSMClassificationNavigationException,
                                             WTException


Supported API: false

Parameters:
navigationNode -
Returns:
AbstractNode
Throws:
CSMClassificationNavigationException
WTException

getNavigationNodeDefaultView

public AbstractNode getNavigationNodeDefaultView(AbstractNodeNodeView navigationNode)
                                          throws CSMClassificationNavigationException,
                                                 WTException


Supported API: false

Parameters:
navigationNode -
Returns:
AbstractNode
Throws:
CSMClassificationNavigationException
WTException

getNodeQueryForms

public NodeQueryForm[] getNodeQueryForms(AbstractNodeDefaultView navigationNode)
                                  throws CSMClassificationNavigationException,
                                         WTException


Supported API: false

Parameters:
navigationNode -
Returns:
NodeQueryForm[]
Throws:
CSMClassificationNavigationException
WTException

getQueryFormElements

public QueryFormElement[] getQueryFormElements(AbstractQueryFormView queryForm)
                                        throws CSMClassificationNavigationException,
                                               WTException


Supported API: false

Parameters:
queryForm -
Returns:
QueryFormElement[]
Throws:
CSMClassificationNavigationException
WTException

refreshNavigationNodeDefaultView

public AbstractNode refreshNavigationNodeDefaultView(AbstractNodeDefaultView navigationNode)
                                              throws CSMClassificationNavigationException,
                                                     WTException


Supported API: false

Parameters:
navigationNode -
Returns:
AbstractNode
Throws:
CSMClassificationNavigationException
WTException

refreshNavigationNodeNodeView

public AbstractNode refreshNavigationNodeNodeView(AbstractNodeNodeView navigationNode)
                                           throws CSMClassificationNavigationException,
                                                  WTException


Supported API: false

Parameters:
navigationNode -
Returns:
AbstractNode
Throws:
CSMClassificationNavigationException
WTException

copyNavigationNode

public IndependentNode copyNavigationNode(IndependentNodeNodeView sourceNavigationNode,
                                          IndependentNodeNodeView targetParentNavigationNode)
                                   throws CSMClassificationNavigationException,
                                          NotAuthorizedException,
                                          WTException


Supported API: false

Parameters:
sourceNavigationNode -
targetParentNavigationNode -
Returns:
IndependentNode
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

createNavigationNode

public IndependentNode createNavigationNode(IndependentNodeDefaultView navigationNode,
                                            AbstractNavStructView navStruct)
                                     throws CSMClassificationNavigationException,
                                            NotAuthorizedException,
                                            WTException


Supported API: false

Parameters:
navigationNode -
navStruct -
Returns:
IndependentNode
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

deleteNavigationNode

public void deleteNavigationNode(IndependentNodeNodeView navigationNode)
                          throws CSMClassificationNavigationException,
                                 NotAuthorizedException,
                                 WTException


Supported API: false

Parameters:
navigationNode -
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

updateNavigationNode

public IndependentNode updateNavigationNode(IndependentNodeNodeView navigationNode)
                                     throws CSMClassificationNavigationException,
                                            NotAuthorizedException,
                                            WTException


Supported API: false

Parameters:
navigationNode -
Returns:
IndependentNode
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

updateNavigationNode

public AbstractNode updateNavigationNode(AbstractNodeDefaultView navigationNode)
                                  throws CSMClassificationNavigationException,
                                         NotAuthorizedException,
                                         WTException


Supported API: false

Parameters:
navigationNode -
Returns:
AbstractNode
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

performStartupProcess

protected void performStartupProcess()
                              throws ManagerException


Supported API: false

Overrides:
performStartupProcess in class StandardManager
Throws:
ManagerException

getNavigationStructureFromID

public AbstractNavStruct getNavigationStructureFromID(String structid)
                                               throws CSMClassificationNavigationException,
                                                      WTException


Supported API: false

Parameters:
structid -
Returns:
AbstractNavStruct
Throws:
CSMClassificationNavigationException
WTException

getNavigationNodeFromID

public AbstractNode getNavigationNodeFromID(String nodeid)
                                     throws CSMClassificationNavigationException,
                                            WTException


Supported API: false

Parameters:
nodeid -
Returns:
AbstractNode
Throws:
CSMClassificationNavigationException
WTException

getParentNodes

public AbstractNode[] getParentNodes(AbstractNodeNodeView navigationNode)
                              throws CSMClassificationNavigationException,
                                     WTException


Supported API: false

Parameters:
navigationNode -
Returns:
AbstractNode[]
Throws:
CSMClassificationNavigationException
WTException

findNavigationNodes

public Vector findNavigationNodes(NavStructListView navStrTarget,
                                  String srcForString,
                                  String matching,
                                  AbstractNodeNodeView navParentNode)
                           throws CSMClassificationNavigationException,
                                  WTException


Supported API: false

Parameters:
navStrTarget -
srcForString -
matching -
navParentNode -
Returns:
Vector
Throws:
CSMClassificationNavigationException
WTException

findNavigationNodes

public Vector findNavigationNodes(String structName,
                                  String srcForString,
                                  String matching,
                                  AbstractNodeNodeView navParentNode)
                           throws CSMClassificationNavigationException,
                                  WTException


Supported API: false

Parameters:
structName -
srcForString -
matching -
navParentNode -
Returns:
Vector
Throws:
CSMClassificationNavigationException
WTException

newNavigationDBService

public static NavigationDBService newNavigationDBService()
                                                  throws WTException
Default factory for the class.

Supported API: false

Returns:
NavigationDBService
Throws:
WTException

getNavigationStructureRootNodes

private AbstractNode[] getNavigationStructureRootNodes(AbstractNavStructView navStruct)
                                                throws CSMClassificationNavigationException,
                                                       WTException
Throws:
CSMClassificationNavigationException
WTException

getHeavyIndependentNodeChildren

protected AbstractNode[] getHeavyIndependentNodeChildren(IndependentNode node)
                                                  throws CSMClassificationNavigationException,
                                                         WTException
Throws:
CSMClassificationNavigationException
WTException

insertIndirectQueryTargetDefaultView

private AbstractNavStructView insertIndirectQueryTargetDefaultView(AbstractNavStruct structure)
                                                            throws CSMClassificationNavigationException,
                                                                   WTException
Throws:
CSMClassificationNavigationException
WTException

insertNodeQueryFormDefaultView

private AbstractNodeDefaultView insertNodeQueryFormDefaultView(AbstractNode node)
                                                        throws CSMClassificationNavigationException,
                                                               WTException
Throws:
CSMClassificationNavigationException
WTException

insertQueryFormElementDefaultView

private AbstractQueryFormView insertQueryFormElementDefaultView(AbstractQueryFormView liteForm)
                                                         throws CSMClassificationNavigationException,
                                                                WTException
Throws:
CSMClassificationNavigationException
WTException

isValidRoot

private boolean isValidRoot(AbstractNodeNodeView node)
                     throws WTException
Throws:
WTException

hasValidLineage

private boolean hasValidLineage(ObjectIdentifier nodeID,
                                IndependentNode parent)
                         throws WTException
Throws:
WTException

hasValidName

private boolean hasValidName(String sourceName,
                             AbstractNode[] siblings)

persistIndirectQueryTarget

private void persistIndirectQueryTarget(AbstractNavStructView navStruct,
                                        AbstractNavStruct heavyNavStruct)
                                 throws CSMClassificationNavigationException,
                                        NotAuthorizedException,
                                        WTException
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

persistDirectQueryTarget

private DirectQueryTarget persistDirectQueryTarget(AbstractNavStructView navStruct)
                                            throws CSMClassificationNavigationException,
                                                   NotAuthorizedException,
                                                   WTException
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

persistNodeQueryForm

private void persistNodeQueryForm(AbstractNode persistedNode,
                                  AbstractNodeDefaultView node)
                           throws CSMClassificationNavigationException,
                                  NotAuthorizedException,
                                  WTException
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

persistQueryFormElement

private void persistQueryFormElement(AbstractQueryFormView liteForm,
                                     AbstractQueryForm form)
                              throws CSMClassificationNavigationException,
                                     NotAuthorizedException,
                                     WTException
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

copyNodeQueryForm

private void copyNodeQueryForm(IndependentNode newNode,
                               IndependentNode oldNode)
                        throws CSMClassificationNavigationException,
                               NotAuthorizedException,
                               WTException
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

recurseCopyNode

protected void recurseCopyNode(IndependentNode parent,
                               AbstractNode[] children)
                        throws CSMClassificationNavigationException,
                               WTException
Throws:
CSMClassificationNavigationException
WTException

deleteNodeQueryForm

private void deleteNodeQueryForm(AbstractNode node)
                          throws CSMClassificationNavigationException,
                                 NotAuthorizedException,
                                 WTException
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

deleteQueryFormElement

private void deleteQueryFormElement(AbstractQueryForm form)
                             throws CSMClassificationNavigationException,
                                    NotAuthorizedException,
                                    WTException
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

recurseDeleteNode

protected void recurseDeleteNode(AbstractNode[] children)
                          throws CSMClassificationNavigationException,
                                 WTException
Throws:
CSMClassificationNavigationException
WTException

deleteDefaultQueryForm

private void deleteDefaultQueryForm(AbstractQueryTarget target)
                             throws CSMClassificationNavigationException,
                                    NotAuthorizedException,
                                    WTException
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

deleteIndirectQueryTarget

private void deleteIndirectQueryTarget(AbstractNavStructView navStruct)
                                throws CSMClassificationNavigationException,
                                       NotAuthorizedException,
                                       WTException
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

deleteDirectQueryTarget

private void deleteDirectQueryTarget(AbstractNavStructView navStruct)
                              throws CSMClassificationNavigationException,
                                     NotAuthorizedException,
                                     WTException
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

getHeavyNavigationNodeChildren

public AbstractNode[] getHeavyNavigationNodeChildren(AbstractNode node)
                                              throws CSMClassificationNavigationException,
                                                     WTException
Throws:
CSMClassificationNavigationException
WTException

recurseDeleteNavigationNode

private void recurseDeleteNavigationNode(AbstractNode[] nodes)
                                  throws CSMClassificationNavigationException,
                                         NotAuthorizedException,
                                         WTException
Throws:
CSMClassificationNavigationException
NotAuthorizedException
WTException

findClassifiStructIdA3A6BasedOnIdA2A2

private long findClassifiStructIdA3A6BasedOnIdA2A2(long idA2A2)
                                            throws CSMClassificationNavigationException,
                                                   WTException
Throws:
CSMClassificationNavigationException
WTException

findNavStructBasedOnName

private AbstractNavStruct findNavStructBasedOnName(String navStructureName)
                                            throws CSMClassificationNavigationException,
                                                   WTException
Throws:
CSMClassificationNavigationException
WTException

formQuerySpec

private QuerySpec formQuerySpec(long navStructId,
                                String navStructClassName,
                                String srcString,
                                String srcPattern)
                         throws QueryException
Throws:
QueryException

extractNodesInNavStruct

public Vector extractNodesInNavStruct(QueryResult qr,
                                      String navStructClassName)
                               throws WTException
extractNodesInNavStruct

Parameters:
qr - a QueryResult object containing the nodes found
navStructClassName - className string of the navigation struct
Returns:
a Vector of Vectors, each element vector is: * A vector of IndependentNodeNodeView OR ClassificationNodeNodeView objects starting at index 0 with the object representing the node itself to the object representing its target parent.
Throws:
WTException

extractNodesInSpecifiedParentNode

public Vector extractNodesInSpecifiedParentNode(QueryResult qr,
                                                String navStructClassName,
                                                AbstractNodeNodeView navParentNode)
                                         throws WTException
Throws:
WTException