PSXRef (PageSeeder Bridge 0.8.3 API)

java.lang.Object
- org.pageseeder.bridge.model.PSXRef

All Implemented Interfaces:

Serializable, PSEntity
```
public final class PSXRef
extends Object
implements PSEntity
```
Represents a PageSeeder XRef.

Since:

0.8.1

Author:

Philip Rutherford

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PSXRef.DISPLAY
XRef titles to display.

static class PSXRef.TYPE
XRef type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PSXRef.DISPLAY` XRef titles to display.
`static class`	`PSXRef.TYPE` XRef type.

Constructor Summary

Constructors
Constructor and Description

PSXRef()
Constructor

Constructors
Constructor and Description
`PSXRef()` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`EntityValidity`	`checkValid()` Determines whether this object is valid based on known PageSeeder constraints.
`String`	`getContent()`
`PSXRef.DISPLAY`	`getDisplay()`
`Long`	`getId()`
`String`	`getIdentifier()` Returns the identifier to use when connecting to PageSeeder based on the ID available.
`String`	`getKey()`
`List<String>`	`getLabels()`
`String`	`getLabelsAsString()`
`Integer`	`getLevel()`
`boolean`	`getReverseLink()`
`String`	`getReverseTitle()`
`PSXRef.TYPE`	`getReverseType()`
`String`	`getSourceDocid()`
`String`	`getSourceFragment()`
`String`	`getSourceHref()`
`String`	`getSourceMediaType()`
`Long`	`getSourceURIId()`
`String`	`getSourceURITitle()`
`String`	`getTargetDocid()`
`String`	`getTargetFragment()`
`String`	`getTargetHref()`
`String`	`getTargetMediaType()`
`Long`	`getTargetURIId()`
`String`	`getTargetURITitle()`
`String`	`getTitle()`
`PSXRef.TYPE`	`getType()`
`boolean`	`isIdentifiable()` Determines whether the entity can be identified in PageSeeder.
`boolean`	`isValid()` Determines whether the entity is valid based on known PageSeeder constraints.
`void`	`setDisplay(PSXRef.DISPLAY display)`
`void`	`setId(Long id)`
`void`	`setLabels(List<String> labels)`
`void`	`setLabels(String labels)`
`void`	`setLevel(Integer level)`
`void`	`setReverseLink(boolean reverseLink)`
`void`	`setReverseTitle(String reverseTitle)`
`void`	`setReverseType(PSXRef.TYPE reverseType)`
`void`	`setSourceFragment(String sourceFragment)`
`void`	`setSourceURI(PSURI sourceURI)`
`void`	`setTargetFragment(String targetFragment)`
`void`	`setTargetURI(PSURI targetURI)`
`void`	`setTitle(String title)`
`void`	`setType(PSXRef.TYPE type)`
`String`	`toString()`

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

- Constructor Detail
  - PSXRef
```
public PSXRef()
```
    Constructor
- Method Detail
  - getId
```
public Long getId()
```
    Specified by:
    
    getId in interface PSEntity
    
    Returns:
    the id
  - getKey
```
public String getKey()
```
    Specified by:
    
    getKey in interface PSEntity
    
    Returns:
    the public ID for the PageSeeder entity.
  - isValid
```
public boolean isValid()
```
    Description copied from interface: PSEntity
    
    Determines whether the entity is valid based on known PageSeeder constraints.
    
    Specified by:
    
    isValid in interface PSEntity
    
    Returns:
    true if the object is intrinsically valid based on its internal values; false if any of its attributes violates a PageSeeder constraint.
  - isIdentifiable
```
public boolean isIdentifiable()
```
    Description copied from interface: PSEntity
    
    Determines whether the entity can be identified in PageSeeder.
    To be identifiable, the entity must have either a private id or a public id.
    If the public ID does not correspond to a single attribute in PageSeeder, then a combination of attributes may be used to determine whether it is possible to identify the entity.
    
    Specified by:
    
    isIdentifiable in interface PSEntity
    
    Returns:
    true if the object can be identified in PageSeeder; false if it is not possible to identify the entity form its attributes or keys.
  - getIdentifier
```
public String getIdentifier()
```
    Description copied from interface: PSEntity
    
    Returns the identifier to use when connecting to PageSeeder based on the ID available.
    When both the private and public identifier are available, the private identifier takes precedence over the public one.
    When the public identifier cannot be used on its own, then only the private ID is returned.
    In general, if the PSEntity.isIdentifiable() method return true, this method should return a value. When it is not the case, it should be clearly documented.
    
    Specified by:
    
    getIdentifier in interface PSEntity
    
    Returns:
    the identifier to use when connecting to PageSeeder.
  - checkValid
```
public EntityValidity checkValid()
```
    Description copied from interface: PSEntity
    
    Determines whether this object is valid based on known PageSeeder constraints.
    
    Specified by:
    
    checkValid in interface PSEntity
    
    Returns:
    true if the object is intrinsically valid based on its internal values; false if any of its attributes violates a PageSeeder constraint.
  - getTargetURIId
```
public Long getTargetURIId()
```
    Returns:
    the target URI ID.
  - getTargetURITitle
```
public String getTargetURITitle()
```
    Returns:
    the target URI title.
  - getTargetMediaType
```
public String getTargetMediaType()
```
    Returns:
    the target Media Type
  - getSourceURIId
```
public Long getSourceURIId()
```
    Returns:
    the source URI ID.
  - getSourceURITitle
```
public String getSourceURITitle()
```
    Returns:
    the source URI title.
  - getSourceMediaType
```
public String getSourceMediaType()
```
    Returns:
    the source Media Type
  - getSourceDocid
```
public String getSourceDocid()
```
    Returns:
    the sourceDocid
  - getSourceHref
```
public String getSourceHref()
```
    Returns:
    the source Href
  - getSourceFragment
```
public String getSourceFragment()
```
    Returns:
    the source fragment.
  - getType
```
public PSXRef.TYPE getType()
```
    Returns:
    the XRef's type
  - getReverseType
```
public PSXRef.TYPE getReverseType()
```
    Returns:
    the reverse type
  - getDisplay
```
public PSXRef.DISPLAY getDisplay()
```
    Returns:
    the display
  - getReverseLink
```
public boolean getReverseLink()
```
    Returns:
    true if this XRef is a reverse xref.
  - getReverseTitle
```
public String getReverseTitle()
```
    Returns:
    the reverse title.
  - getLevel
```
public Integer getLevel()
```
    Returns:
    the numbering level
  - getTargetDocid
```
public String getTargetDocid()
```
    Returns:
    the target Docid
  - getTargetHref
```
public String getTargetHref()
```
    Returns:
    the target Href
  - getTargetFragment
```
public String getTargetFragment()
```
    Returns:
    the target fragment.
  - getTitle
```
public String getTitle()
```
    Returns:
    the title.
  - getLabels
```
public final List<String> getLabels()
```
    Returns:
    the labels
  - getLabelsAsString
```
public final String getLabelsAsString()
```
    Returns:
    The labels as a comma-separated list.
  - getContent
```
public String getContent()
```
    Returns:
    the content of the XRef.
  - setTargetURI
```
public void setTargetURI(PSURI targetURI)
```
    Parameters:
    targetURI - the new target URI
  - setTitle
```
public void setTitle(String title)
```
    Parameters:
    title - the new title to set
  - setLabels
```
public final void setLabels(String labels)
```
    Parameters:
    labels - The labels as a comma-separated list.
  - setId
```
public void setId(Long id)
```
    Parameters:
    id - the id to set
  - setSourceURI
```
public void setSourceURI(PSURI sourceURI)
```
    Parameters:
    sourceURI - the source URI to set
  - setSourceFragment
```
public void setSourceFragment(String sourceFragment)
```
    Parameters:
    sourceFragment - the source Fragment to set
  - setTargetFragment
```
public void setTargetFragment(String targetFragment)
```
    Parameters:
    targetFragment - the target Fragment to set
  - setReverseLink
```
public void setReverseLink(boolean reverseLink)
```
    Parameters:
    reverseLink - the reverseLink to set
  - setReverseTitle
```
public void setReverseTitle(String reverseTitle)
```
    Parameters:
    reverseTitle - the reverse Title to set
  - setLevel
```
public void setLevel(Integer level)
```
    Parameters:
    level - the level to set
  - setDisplay
```
public void setDisplay(PSXRef.DISPLAY display)
```
    Parameters:
    display - the display to set
  - setType
```
public void setType(PSXRef.TYPE type)
```
    Parameters:
    type - the type to set
  - setReverseType
```
public void setReverseType(PSXRef.TYPE reverseType)
```
    Parameters:
    reverseType - the reverse Type to set
  - setLabels
```
public void setLabels(List<String> labels)
```
    Parameters:
    labels - the labels to set
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PSXRef

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PSXRef

Method Detail

getId

getKey

isValid

isIdentifiable

getIdentifier

checkValid

getTargetURIId

getTargetURITitle

getTargetMediaType

getSourceURIId

getSourceURITitle

getSourceMediaType

getSourceDocid

getSourceHref

getSourceFragment

getType

getReverseType

getDisplay

getReverseLink

getReverseTitle

getLevel

getTargetDocid

getTargetHref

getTargetFragment

getTitle

getLabels

getLabelsAsString

getContent

setTargetURI

setTitle

setLabels

setId

setSourceURI

setSourceFragment

setTargetFragment

setReverseLink

setReverseTitle

setLevel

setDisplay

setType

setReverseType

setLabels

toString