Overview | Package | Class | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## es.upm.gib.mappingAPI2
Class Entry

    java.lang.Object
      es.upm.gib.mappingAPI2.Entry

All Implemented Interfaces:
  java.io.Serializable

    public class Entry

extends java.lang.Object
implements java.io.Serializable

This class represents one entry of the mapping Each entry of the model has: - two views: one conceptual, one physical - brief description - some custom data - author of the entry - date of creation - name of last person who modifies the entry - last date of modification - list of external bounds

See Also:
  Serialized Form

Constructor Summary
`Entry(View conceptual, View physical)` creates a new entry.

Method Summary
`void` | `addExternalBound(CoordinatesBound bound)` This method adds a bound to the external bounds of the entry
`boolean` | `equals(java.lang.Object entry)` compares two Entry objects.
`java.lang.String` | `getAuthor()` This method returns author name of the entry
`java.util.ArrayList<Identifier>` | `getConceptualIdentifiers()`
`View` | `getConceptualView()` This method retrieves the conceptual view of the entry
`java.util.Date` | `getCreationDate()` This method returns the creation date of the entry
`CustomData` | `getCustomData()` This method returns the custom data defined in the entry
`java.lang.String` | `getDescription()` this method returns the natural language description of this entry.
`java.util.ArrayList<CoordinatesBound>` | `getExternalBounds()` this method returns all the external bounds defined in the entry.
`java.util.Date` | `getLastModificationDate()` This method retrieves the date of the last modification of the entry
`java.lang.String` | `getLastModifiedBy()` The method retrieves the name of the last author who modifies the entry
`java.util.ArrayList<Identifier>` | `getPhysicalIdentifiers()`
`View` | `getPhysicalView()` This method retrieves the physical view of the entry
`boolean` | `isConceptualIdentifier(Identifier identifier)`
`boolean` | `isPhysicalIdentifier(Identifier identifier)`
`void` | `setAuthor(java.lang.String author)` This method sets author name of the entry
`void` | `setConceptualView(View conceptualView)` This method set the conceptual view into the entry
`void` | `setCreationDate(java.util.Date creationDate)` This method sets the creation date of the entry
`void` | `setCustomData(CustomData customData)` This method puts the input custom data into the entry
`void` | `setDescription(java.lang.String desc)` this method defines a natural language description of this entry.
`void` | `setExternalBounds(java.util.ArrayList<CoordinatesBound> extBounds)` This method set the list of external bounds into the entry
`void` | `setLastModificationDate(java.util.Date lastModificationDate)` This method sets the last modification date of the entry
`void` | `setLastModifiedBy(java.lang.String lastModifiedBy)` The method sets the name of the last author who modifies the entry
`void` | `setPhysicalView(View physicalView)` This method set the physical view into the entry
`void` | `setRestriction(java.util.ArrayList<CoordinatesBound> bounds)` sets the external bounds
`java.lang.String` | `toString()` returns an entry as a string representation.

Methods inherited from class java.lang.Object
`clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### Entry

    public Entry(View conceptual,
                 View physical)

  creates a new entry. the parameters are Views objects representing a conceptual view and a physical view. A view is a set of paths. The format of the path is given in the following example: if we want to define a path from ClassA to ClassC like this: ClassA---[Rel1]--->ClassB---[Rel2]--->ClassC the correspondent Vector will be composed by two triples: [Triple1,Triple2] , where Triple1 is ["ClassA","Rel1","ClassB"] and Triple2 is ["ClassB","Rel2","ClassC"]
  so the final correspondent vector is:
  [["ClassA","Rel1","ClassB"],["ClassB","Rel2","ClassC"]]

  Parameters:
    `conceptual` - a view into the conceptual schema
    `physical` - a view into the physical schema

Method Detail

### getCustomData

    public CustomData getCustomData()

  This method returns the custom data defined in the entry

  Returns:
    custom data of the entry

### setCustomData

    public void setCustomData(CustomData customData)

  This method puts the input custom data into the entry

  Parameters:
    `customData` -

### getPhysicalIdentifiers

    public java.util.ArrayList<Identifier> getPhysicalIdentifiers()

### getConceptualIdentifiers

    public java.util.ArrayList<Identifier> getConceptualIdentifiers()

### isPhysicalIdentifier

    public boolean isPhysicalIdentifier(Identifier identifier)

### isConceptualIdentifier

    public boolean isConceptualIdentifier(Identifier identifier)

### getExternalBounds

    public java.util.ArrayList<CoordinatesBound> getExternalBounds()

  this method returns all the external bounds defined in the entry. An external bound is a pair of pairs of integer. the first pair of integer refers to the conceptual view of the view, the second pair to the physical view of the entry. for each pair, the first integer represent the number of the path it refers and the second integer refers to the nomber of the class in the path.

  for example the external bound ((0,2),(1,1)) bounds: the class 2 of the path 0 in the conceptual view with the class 1 of the path 1 in the physical view

  Returns:
    a vector of External Bounds

### setExternalBounds

    public void setExternalBounds(java.util.ArrayList<CoordinatesBound> extBounds)

  This method set the list of external bounds into the entry

  Parameters:
    `extBounds` - List of external bounds

### getPhysicalView

    public View getPhysicalView()

  This method retrieves the physical view of the entry

  Returns:
    physical view

### setPhysicalView

    public void setPhysicalView(View physicalView)

  This method set the physical view into the entry

  Parameters:
    `physicalView` -

### getConceptualView

    public View getConceptualView()

  This method retrieves the conceptual view of the entry

  Returns:
    conceptual view

### setConceptualView

    public void setConceptualView(View conceptualView)

  This method set the conceptual view into the entry

  Parameters:
    `conceptualView` -

### getAuthor

    public java.lang.String getAuthor()

  This method returns author name of the entry

  Returns:
    author of the entry

### setAuthor

    public void setAuthor(java.lang.String author)

  This method sets author name of the entry

  Parameters:
    `author` - name of the author

### getCreationDate

    public java.util.Date getCreationDate()

  This method returns the creation date of the entry

  Returns:
    creation date of the entry

### setCreationDate

    public void setCreationDate(java.util.Date creationDate)

  This method sets the creation date of the entry

  Parameters:
    `creationDate` - creation date of the entry

### getLastModifiedBy

    public java.lang.String getLastModifiedBy()

  The method retrieves the name of the last author who modifies the entry

  Returns:
    name of last author

### setLastModifiedBy

    public void setLastModifiedBy(java.lang.String lastModifiedBy)

  The method sets the name of the last author who modifies the entry

  Parameters:
    `lastModifiedBy` - name of the author

### getLastModificationDate

    public java.util.Date getLastModificationDate()

  This method retrieves the date of the last modification of the entry

  Returns:
    las modification date

### setLastModificationDate

    public void setLastModificationDate(java.util.Date lastModificationDate)

  This method sets the last modification date of the entry

  Parameters:
    `lastModificationDate` - last modification date

### setDescription

    public void setDescription(java.lang.String desc)

  this method defines a natural language description of this entry.

  Parameters:
    `desc` - the natural language description of this entry.

### getDescription

    public java.lang.String getDescription()

  this method returns the natural language description of this entry.

  Returns:
    the natural language description of this entry.

### setRestriction

    public void setRestriction(java.util.ArrayList<CoordinatesBound> bounds)

  sets the external bounds

  Parameters:
    `bounds` - a vector of external bounds

### addExternalBound

    public void addExternalBound(CoordinatesBound bound)

  This method adds a bound to the external bounds of the entry

  Parameters:
    `bound` - bound to add

### equals

    public boolean equals(java.lang.Object entry)

  compares two Entry objects. The comparation is true if the values of the instance variables are equivalent.
  conceptually this means that the two Entry have equivalent conceptual and physical views.

  Overrides:
    `equals` in class `java.lang.Object`
  Parameters:
    `entry` - the Entry to compare
  Returns:
    if the two objects are equivalent or not

### toString

    public java.lang.String toString()

  returns an entry as a string representation.

  Overrides:
    `toString` in class `java.lang.Object`
  Returns:
    an entry as a String

Overview | Package | Class | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD