Interface ItemsXml
- All Known Implementing Classes:
TestItemsXml
public interface ItemsXml
The XML interface that extracts specified items from an xml file
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsAttribute(String itemType, String attributeName) Checks whether the specified item type attribute is present in the context of this items.xml file.Retrieves all type codes, which directly or indirectly present in this item XML fileRetrieves all type codes, which explicitly present and created in this file.Retrieves item types defined in this file.
-
Method Details
-
getContextTypeCodes
Collection<String> getContextTypeCodes()Retrieves all type codes, which directly or indirectly present in this item XML file- Returns:
- type codes for complex type, enums, map types, etc., which are defined in this item XML and also all type codes for the types extended by the items in this items XML. If this file is empty, then an empty collection is returned;
-
getCreatedTypeCodes
Collection<String> getCreatedTypeCodes()Retrieves all type codes, which explicitly present and created in this file. If a type is present but simply adds more attributes to a type that was created in a different file, then it's excluded from the type codes returned by this method.- Returns:
- a collection of item type codes defined in this items.xml file or an empty collection, if this file is empty.
-
getItemTypes
Collection<ItemType> getItemTypes()Retrieves item types defined in this file.- Returns:
- all item types contained in this items.xml or an empty collection, if this file does not contain complex item types.
-
containsAttribute
Checks whether the specified item type attribute is present in the context of this items.xml file.- Parameters:
itemType- type code of the item that should contain the specified attribute. It may be not only item type explicitly defined in this file but also an item type inherited by an item definition in this file or an item type from referenced in a relation in this file, etc.attributeName- name of the attribute to check for the existence in the specified item type. The attribute may be defined in this file or used in a relation or in an inherited item type, etc.- Returns:
true, if the specified item contains the attribute;false, if either the item is not found for the specifieditemTypeor the item does not contain the specified attribute.
-