Class that can be used to specify nested or wild carded property keys. E.g. for the use in context of the property persistence service or the property relation service.
Following assumptions are made /preconditions are defined: More...

#include <mitkPropertyKeyPath.h>

Collaboration diagram for mitk::PropertyKeyPath:

[legend]

Classes
struct	NodeInfo

Public Types
using	ItemSelectionIndex = std::vcl_size_t

using	ElementNameType = std::string

using	NodeInfoVectorType = std::vector< NodeInfo >

using	PathIndexType = NodeInfoVectorType::size_type

Public Member Functions
bool	IsEmpty () const

bool	IsExplicit () const

bool	HasItemSelectionWildcardsOnly () const

PathIndexType	GetSize () const

PathIndexType	AddNode (const NodeInfo &newNode)

const NodeInfo &	GetNode (const PathIndexType &index) const

NodeInfo &	GetNode (const PathIndexType &index)

NodeInfo &	GetFirstNode ()

const NodeInfo &	GetFirstNode () const

NodeInfo &	GetLastNode ()

const NodeInfo &	GetLastNode () const

const NodeInfoVectorType &	GetNodes () const

bool	operator== (const PropertyKeyPath &path) const

bool	operator< (const PropertyKeyPath &right) const

bool	operator<= (const PropertyKeyPath &right) const

bool	operator>= (const PropertyKeyPath &right) const

bool	operator> (const PropertyKeyPath &right) const

bool	Equals (const PropertyKeyPath &path) const

PropertyKeyPath &	operator= (const PropertyKeyPath &path)

PropertyKeyPath &	AddAnyElement ()

PropertyKeyPath &	AddElement (const ElementNameType &name)

PropertyKeyPath &	AddAnySelection (const ElementNameType &name)

PropertyKeyPath &	AddSelection (const ElementNameType &name, ItemSelectionIndex index)

	PropertyKeyPath ()

	PropertyKeyPath (const PropertyKeyPath &path)

	~PropertyKeyPath ()

void	Reset ()

Static Protected Member Functions
static bool	PropertyKeyPathsMatch (const PropertyKeyPath &left, const PropertyKeyPath &right)

Protected Attributes
NodeInfoVectorType	m_NodeInfos

Detailed Description

Class that can be used to specify nested or wild carded property keys. E.g. for the use in context of the property persistence service or the property relation service.
Following assumptions are made /preconditions are defined:

A property key is partitioned by "." into nodes (c.f. visualization of property keys in the PropertyView).
A node can either be an element or a selection.
An element has a name (alphanumric, - and space; "A-Za-z0-9- ") or is wildcarded ("*")
A selection is either an index (e.g. "[1]") or a wildcard ("[*]").

Selections are used to indicate that the preceding element has multiple occurences and which occurence is meant. Example property keys would be:

prop : A simple property key
prop.subprop1 : A property key consting of two nodes
prop.* : Any property key that starts with a node "prop"
prop.sub.[2] : A property key that starts with a node "prop" and a has a second node that is selection and has the index 2.
prop.sub.[*] : Any property key that starts with a node "prop" and a has a second node that is selection (with any index).

To build a path one may use the Add* method to build up the PropertyKeyPath element by element.
"first.*.third.[3]" would be equivalent to propKeyPath.AddElement("first"); propKeyPath.AddAnyElement(); propKeyPath.AddSelection("third",3);
or the inline version propKeyPath.AddElement("first").AddAnyElement().AddSelection("third",3);

Definition at line 51 of file mitkPropertyKeyPath.h.

Member Typedef Documentation

◆ ElementNameType

using mitk::PropertyKeyPath::ElementNameType = std::string

Definition at line 55 of file mitkPropertyKeyPath.h.

◆ ItemSelectionIndex

using mitk::PropertyKeyPath::ItemSelectionIndex = std::vcl_size_t

Definition at line 54 of file mitkPropertyKeyPath.h.

◆ NodeInfoVectorType

using mitk::PropertyKeyPath::NodeInfoVectorType = std::vector<NodeInfo>

Definition at line 79 of file mitkPropertyKeyPath.h.

◆ PathIndexType

using mitk::PropertyKeyPath::PathIndexType = NodeInfoVectorType::size_type

Definition at line 80 of file mitkPropertyKeyPath.h.

Constructor & Destructor Documentation

◆ PropertyKeyPath() [1/2]

mitk::PropertyKeyPath::PropertyKeyPath ( )

Definition at line 277 of file mitkPropertyKeyPath.cpp.

References Reset().

Referenced by mitk::PropertyNameToPropertyKeyPath().

◆ PropertyKeyPath() [2/2]

mitk::PropertyKeyPath::PropertyKeyPath ( const PropertyKeyPath & path )

Definition at line 279 of file mitkPropertyKeyPath.cpp.

◆ ~PropertyKeyPath()

mitk::PropertyKeyPath::~PropertyKeyPath ( )

Definition at line 281 of file mitkPropertyKeyPath.cpp.

Member Function Documentation

◆ AddAnyElement()

PropertyKeyPath & mitk::PropertyKeyPath::AddAnyElement ( )

Appends an "any element" to the path instance.

Definition at line 253 of file mitkPropertyKeyPath.cpp.

References mitk::PropertyKeyPath::NodeInfo::AnyElement, and m_NodeInfos.

Referenced by mitk::SourceImageRelationRule::Disconnect_datalayer(), and mitk::PropertyNameToPropertyKeyPath().

◆ AddAnySelection()

PropertyKeyPath & mitk::PropertyKeyPath::AddAnySelection ( const ElementNameType & name )

Appends an element with the passed name and any selection to the path instance.

Definition at line 265 of file mitkPropertyKeyPath.cpp.

References mitk::PropertyKeyPath::NodeInfo::AnySelection, and m_NodeInfos.

Referenced by mitk::SourceImageRelationRule::CreateNewSourceImageSequenceItem(), mitk::SourceImageRelationRule::GetReferenceSequenceIndices(), and mitk::PropertyNameToPropertyKeyPath().

◆ AddElement()

PropertyKeyPath & mitk::PropertyKeyPath::AddElement ( const ElementNameType & name )

Appends an element with the passed name to the path instance.

Definition at line 259 of file mitkPropertyKeyPath.cpp.

References mitk::PropertyKeyPath::NodeInfo::Element, and m_NodeInfos.

Referenced by mitk::SourceImageRelationRule::Connect_datalayer(), mitk::SourceImageRelationRule::CreateNewSourceImageSequenceItem(), mitk::SourceImageRelationRule::Disconnect_datalayer(), mitk::SourceImageRelationRule::GetReferenceSequenceIndices(), mitk::PropertyRelationRuleBase::GetRootKeyPath(), mitk::PropertyRelationRuleBase::GetRuleIDByInstanceID(), mitk::SourceImageRelationRule::HasImplicitDataRelation(), and mitk::PropertyNameToPropertyKeyPath().

◆ AddNode()

PropertyKeyPath::PathIndexType mitk::PropertyKeyPath::AddNode ( const NodeInfo & newNode )

Adds a new node to the end of the path.

Parameters

[in] newNode Reference to the node that should be added.

Returns: Returns the index of the newly added node.

Definition at line 96 of file mitkPropertyKeyPath.cpp.

References m_NodeInfos.

◆ AddSelection()

PropertyKeyPath & mitk::PropertyKeyPath::AddSelection	(	const ElementNameType &	name,
		ItemSelectionIndex	index
	)

Appends an element with the passed name and selection index to the path instance.

Definition at line 271 of file mitkPropertyKeyPath.cpp.

References mitk::PropertyKeyPath::NodeInfo::ElementSelection, and m_NodeInfos.

Referenced by mitk::SourceImageRelationRule::Connect_datalayer(), mitk::SourceImageRelationRule::CreateNewSourceImageSequenceItem(), mitk::SourceImageRelationRule::Disconnect_datalayer(), mitk::SourceImageRelationRule::GetReferenceSequenceIndices(), mitk::SourceImageRelationRule::HasImplicitDataRelation(), and mitk::PropertyNameToPropertyKeyPath().

◆ Equals()

bool mitk::PropertyKeyPath::Equals ( const PropertyKeyPath & path ) const

Checks if two PropertyKeyPaths specify the same node. Hence all wildcards will be processed.
E.G.: "item1.child1.grandChild2" == "item1.*.grandChild2" is true.

Remarks: If you want to check if two paths are "truly" equal and not only equal in terms of pointing to the same node, use the member function operator ==().

Definition at line 241 of file mitkPropertyKeyPath.cpp.

References PropertyKeyPathsMatch().

◆ GetFirstNode() [1/2]

PropertyKeyPath::NodeInfo & mitk::PropertyKeyPath::GetFirstNode ( )

Function returns the node info of the first path node within the PropertyKeyPath.

Precondition: PropertyKeyPath must not be empty.

Returns: Info of the first path node. If the path is empty, an InvalidPathNode exception will be thrown.

Definition at line 135 of file mitkPropertyKeyPath.cpp.

References GetNode(), m_NodeInfos, and mitkThrowException.

◆ GetFirstNode() [2/2]

const PropertyKeyPath::NodeInfo & mitk::PropertyKeyPath::GetFirstNode ( ) const

Function returns the node info of the first path node within the PropertyKeyPath.

Precondition: PropertyKeyPath must not be empty.

Returns: Info of the first path node. If the path is empty, an InvalidPathNode exception will be thrown.

Definition at line 126 of file mitkPropertyKeyPath.cpp.

References GetNode(), m_NodeInfos, and mitkThrowException.

◆ GetLastNode() [1/2]

PropertyKeyPath::NodeInfo & mitk::PropertyKeyPath::GetLastNode ( )

Function returns the node info of the last path node within the PropertyKeyPath.

Precondition: PropertyKeyPath must not be empty.

Returns: Info of the first path node. If the path is empty, an InvalidPathNode exception will be thrown.

Definition at line 153 of file mitkPropertyKeyPath.cpp.

References GetNode(), GetSize(), m_NodeInfos, and mitkThrowException.

◆ GetLastNode() [2/2]

const PropertyKeyPath::NodeInfo & mitk::PropertyKeyPath::GetLastNode ( ) const

Function returns the node info of the last path node within the PropertyKeyPath.

Precondition: PropertyKeyPath must not be empty.

Returns: Info of the first path node. If the path is empty, an InvalidPathNode exception will be thrown.

Definition at line 144 of file mitkPropertyKeyPath.cpp.

References GetNode(), GetSize(), m_NodeInfos, and mitkThrowException.

◆ GetNode() [1/2]

const PropertyKeyPath::NodeInfo & mitk::PropertyKeyPath::GetNode ( const PathIndexType & index ) const

Function returns the node info of a path node specified by the index within the PropertyKeyPath.

Precondition: Passed index must not be out of bounds.

Parameters

[in] index Index of the node whose info should be retrieved.

Returns: Info of the specified path node. If the index is out of bound an InvalidPathNode exception will be thrown.

Definition at line 102 of file mitkPropertyKeyPath.cpp.

References GetSize(), m_NodeInfos, mitkThrowException, and mitk::PropertyKeyPathToPropertyName().

Referenced by GetFirstNode(), and GetLastNode().

◆ GetNode() [2/2]

PropertyKeyPath::NodeInfo & mitk::PropertyKeyPath::GetNode ( const PathIndexType & index )

Function returns the node info of a path node specified by the index within the PropertyKeyPath.

Precondition: Passed index must not be out of bounds.

Parameters

[in] index Index of the node whose info should be retrieved.

Returns: Info of the specified path node. If the index is out of bound an InvalidPathNode exception will be thrown.

Definition at line 114 of file mitkPropertyKeyPath.cpp.

References GetSize(), m_NodeInfos, mitkThrowException, and mitk::PropertyKeyPathToPropertyName().

◆ GetNodes()

const PropertyKeyPath::NodeInfoVectorType & mitk::PropertyKeyPath::GetNodes ( ) const

Definition at line 162 of file mitkPropertyKeyPath.cpp.

References m_NodeInfos.

Referenced by PropertyKeyPathsMatch(), mitk::PropertyKeyPathToPersistenceKeyRegEx(), mitk::PropertyKeyPathToPersistenceKeyTemplate(), mitk::PropertyKeyPathToPersistenceNameTemplate(), mitk::PropertyKeyPathToPropertyName(), and mitk::PropertyKeyPathToPropertyRegEx().

◆ GetSize()

PropertyKeyPath::PathIndexType mitk::PropertyKeyPath::GetSize ( ) const

Number of path nodes the PropertyKeyPath contains.

Definition at line 94 of file mitkPropertyKeyPath.cpp.

References m_NodeInfos.

Referenced by GetLastNode(), and GetNode().

◆ HasItemSelectionWildcardsOnly()

bool mitk::PropertyKeyPath::HasItemSelectionWildcardsOnly ( ) const

Returns if the path has any nodes with item selection wild cards ([*]).

Definition at line 79 of file mitkPropertyKeyPath.cpp.

References mitk::PropertyKeyPath::NodeInfo::AnyElement, mitk::PropertyKeyPath::NodeInfo::AnySelection, and m_NodeInfos.

◆ IsEmpty()

bool mitk::PropertyKeyPath::IsEmpty ( ) const

Returns if the PropertyKeyPath is empty.

Definition at line 64 of file mitkPropertyKeyPath.cpp.

References m_NodeInfos.

◆ IsExplicit()

bool mitk::PropertyKeyPath::IsExplicit ( ) const

Returns if the path is explicit (has no wildcards).

Definition at line 66 of file mitkPropertyKeyPath.cpp.

References mitk::PropertyKeyPath::NodeInfo::AnyElement, mitk::PropertyKeyPath::NodeInfo::AnySelection, and m_NodeInfos.

◆ operator<()

bool mitk::PropertyKeyPath::operator< ( const PropertyKeyPath & right ) const

Operation equals like comparing the ToStr() results with operator <.

Definition at line 166 of file mitkPropertyKeyPath.cpp.

References m_NodeInfos.

◆ operator<=()

bool mitk::PropertyKeyPath::operator<= ( const PropertyKeyPath & right ) const

Operation equals like comparing the ToStr() results with operator <=.

Definition at line 239 of file mitkPropertyKeyPath.cpp.

◆ operator=()

PropertyKeyPath & mitk::PropertyKeyPath::operator= ( const PropertyKeyPath & path )

Definition at line 243 of file mitkPropertyKeyPath.cpp.

References m_NodeInfos.

◆ operator==()

bool mitk::PropertyKeyPath::operator== ( const PropertyKeyPath & path ) const

Compares two PropertyKeyPaths for real equality. So it is a string comparison of their string conversion.

Definition at line 164 of file mitkPropertyKeyPath.cpp.

References m_NodeInfos.

◆ operator>()

bool mitk::PropertyKeyPath::operator> ( const PropertyKeyPath & right ) const

Operation equals like comparing the ToStr() results with operator >.

Definition at line 209 of file mitkPropertyKeyPath.cpp.

References m_NodeInfos.

◆ operator>=()

bool mitk::PropertyKeyPath::operator>= ( const PropertyKeyPath & right ) const

Operation equals like comparing the ToStr() results with operator >=.

Definition at line 237 of file mitkPropertyKeyPath.cpp.

◆ PropertyKeyPathsMatch()

bool mitk::PropertyKeyPath::PropertyKeyPathsMatch	(	const PropertyKeyPath &	left,
		const PropertyKeyPath &	right
	)

staticprotected

Definition at line 285 of file mitkPropertyKeyPath.cpp.

References GetNodes().

Referenced by Equals().

◆ Reset()

void mitk::PropertyKeyPath::Reset ( )

Definition at line 283 of file mitkPropertyKeyPath.cpp.

References m_NodeInfos.

Referenced by PropertyKeyPath().

Member Data Documentation

◆ m_NodeInfos

NodeInfoVectorType mitk::PropertyKeyPath::m_NodeInfos

protected

Definition at line 177 of file mitkPropertyKeyPath.h.

Referenced by AddAnyElement(), AddAnySelection(), AddElement(), AddNode(), AddSelection(), GetFirstNode(), GetLastNode(), GetNode(), GetNodes(), GetSize(), HasItemSelectionWildcardsOnly(), IsEmpty(), IsExplicit(), operator<(), operator=(), operator==(), operator>(), and Reset().

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ElementNameType

◆ ItemSelectionIndex

◆ NodeInfoVectorType

◆ PathIndexType

Constructor & Destructor Documentation

◆ PropertyKeyPath() [1/2]

◆ PropertyKeyPath() [2/2]

◆ ~PropertyKeyPath()

Member Function Documentation

◆ AddAnyElement()

◆ AddAnySelection()

◆ AddElement()

◆ AddNode()

◆ AddSelection()

◆ Equals()

◆ GetFirstNode() [1/2]

◆ GetFirstNode() [2/2]

◆ GetLastNode() [1/2]

◆ GetLastNode() [2/2]

◆ GetNode() [1/2]

◆ GetNode() [2/2]

◆ GetNodes()

◆ GetSize()

◆ HasItemSelectionWildcardsOnly()

◆ IsEmpty()

◆ IsExplicit()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ PropertyKeyPathsMatch()

◆ Reset()

Member Data Documentation

◆ m_NodeInfos