Class StructureItem

  • Direct Known Subclasses:
    StructureMCID, StructureObject

    public abstract class StructureItem
    extends java.lang.Object
    The abstract StructureItem class is extended by StructureMCID and StructureObject.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int pageref
      The object number of the page to which this structure item belongs.
    • Constructor Summary

      Constructors 
      Constructor Description
      StructureItem()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int checkMCID​(int pageref, int mcid)
      Checks if an MCID corresponds with the MCID stored in the StructureItem.
      int checkStructParent​(int pageref, int structParent)
      Checks if a StructParent corresponds with the StructParent stored in the StructureItem.
      int getPageref()
      Returns the number of the page object to which the structure item belongs.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • pageref

        protected int pageref
        The object number of the page to which this structure item belongs.
    • Constructor Detail

      • StructureItem

        public StructureItem()
    • Method Detail

      • getPageref

        public int getPageref()
        Returns the number of the page object to which the structure item belongs.
        Returns:
        a number of the reference of a page
      • checkMCID

        public int checkMCID​(int pageref,
                             int mcid)
        Checks if an MCID corresponds with the MCID stored in the StructureItem.
        Parameters:
        pageref - the page reference that needs to be checked
        mcid - the MCID that needs to be checked
        Returns:
        0 in case there's no MCID (in case of a StructureObject), 1 in case the MCID matches, -1 in case there's no match.
      • checkStructParent

        public int checkStructParent​(int pageref,
                                     int structParent)
        Checks if a StructParent corresponds with the StructParent stored in the StructureItem.
        Parameters:
        pageref - the page reference that needs to be checked
        structParent - the structParent that needs to be checked
        Returns:
        0 in case there's no StructParent (in case of a StructureMCID) 1 in case the StructParent matches, -1 in case there's no match.