public abstract class OwStandardDecoratorSearchNode extends OwSearchNode
OwSearchNode wrapper to implement a decorator pattern.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
OwSearchNode.OwSearchList, OwSearchNode.OwSearchMap, OwSearchNode.OwSearchNodeFieldProvider
FILTER_HIDDEN, FILTER_NONE, FILTER_NONPROPERTY, FILTER_READONLY, m_Childs, m_Criteria, m_iNodeType, m_iOp, NODE_TYPE_CBR, NODE_TYPE_COMBINATION, NODE_TYPE_CRITERIA, NODE_TYPE_PROPERTY, NODE_TYPE_SPECIAL, PERSIST_END_RANGE_NAME, PERSIST_OPERATOR_ATTR_NAME, PERSIST_SEARCH_NODE_NAME, PERSIST_START_RANGE_NAME, PERSIST_UNIQUE_NAME__ATTR_NAME, SEARCH_OP_AND, SEARCH_OP_OR, SEARCH_OP_UNDEF
Constructor and Description |
---|
OwStandardDecoratorSearchNode() |
Modifier and Type | Method and Description |
---|---|
void |
add(OwSearchNode search_p)
add a search node.
|
Object |
clone()
clone the search tree
|
abstract OwSearchCriteria |
createWrappedCriteria(OwSearchCriteria criteria_p)
get the decorated object, to be implemented be overridden classes
|
void |
dump(Writer w_p)
dump the search tree
|
OwSearchNode |
findSearchNode(int nodeType_p)
find the first occurrence of a search node
|
List |
getChilds()
get children of this search node which are combined using the m_iOp Operator
|
OwSearchCriteria |
getCriteria()
get the criteria of this node
|
List |
getCriteriaList(int filter_p)
get a list which contains all the criteria in the OwSearchNode Tree
|
Map |
getCriteriaMap(int filter_p)
get a map which maps all the criteria in the OwSearchNode Tree to their unique name
|
OwFieldProvider |
getFieldProvider()
get a field provider interface for the search
|
int |
getNodeType()
get the type of the branch can be one of the NODE_TYPE_...
|
int |
getOperator()
get the criteria operator which should be applied to the subnodes as defined in OwSearchCriteria
|
Node |
getPersistentNode(Document doc_p)
get a XML node that persists the current state of the criteria
and that can be used with setPersistentNode() to recreate the state
|
abstract OwSearchNode |
getWrappedSearchNode()
get the decorated object, to be implemented be overridden classes
|
boolean |
isCriteriaNode()
check if search node is a criteria node
|
boolean |
isEmpty()
check if any criteria are set
|
boolean |
isValid()
(overridable) check if search tree is valid, can be used to perform a search,
or if required fields are missing, or if no criteria where submitted.
|
void |
reset()
clear all criteria and set to default values
|
void |
setPersistentNode(Node persistentNode_p)
set a XML node that persists the current state of the criteria
|
toString
public abstract OwSearchNode getWrappedSearchNode()
public abstract OwSearchCriteria createWrappedCriteria(OwSearchCriteria criteria_p)
public OwSearchCriteria getCriteria()
OwSearchNode
getCriteria
in class OwSearchNode
public List getCriteriaList(int filter_p)
OwSearchNode
getCriteriaList
in class OwSearchNode
filter_p
- int any combination of OwSearchNode.FILTER_...public Map getCriteriaMap(int filter_p)
OwSearchNode
getCriteriaMap
in class OwSearchNode
filter_p
- int any combination of OwSearchNode.FILTER_...public void add(OwSearchNode search_p) throws Exception
OwSearchNode
add
in class OwSearchNode
search_p
- the search to addException
public Object clone() throws CloneNotSupportedException
OwSearchNode
clone
in class OwSearchNode
CloneNotSupportedException
public void dump(Writer w_p) throws Exception
OwSearchNode
dump
in class OwSearchNode
Exception
public OwSearchNode findSearchNode(int nodeType_p)
OwSearchNode
findSearchNode
in class OwSearchNode
public List getChilds()
OwSearchNode
getChilds
in class OwSearchNode
public OwFieldProvider getFieldProvider()
OwSearchNode
getFieldProvider
in class OwSearchNode
public int getNodeType()
OwSearchNode
getNodeType
in class OwSearchNode
public int getOperator()
OwSearchNode
getOperator
in class OwSearchNode
public Node getPersistentNode(Document doc_p) throws Exception
OwSearchNode
getPersistentNode
in class OwSearchNode
Exception
public boolean isCriteriaNode()
OwSearchNode
isCriteriaNode
in class OwSearchNode
public boolean isEmpty()
OwSearchNode
isEmpty
in class OwSearchNode
public boolean isValid() throws Exception
OwSearchNode
isValid
in class OwSearchNode
Exception
public void reset() throws Exception
OwSearchNode
reset
in class OwSearchNode
Exception
public void setPersistentNode(Node persistentNode_p) throws Exception
OwSearchNode
setPersistentNode
in class OwSearchNode
persistentNode_p
- org.w3c.dom.Node XML nodeException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.